From 48749cf7aa7861a8b552f4722364908f26b16da6 Mon Sep 17 00:00:00 2001 From: Jackson <163934542+jmintuitive@users.noreply.github.com> Date: Mon, 1 Apr 2024 13:11:34 -0700 Subject: [PATCH] Make reference docs very prominent in the README (#346) * Update README.md Add the link to the reference docs very clearly in the README * Move old reference docs section up --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b3ae157a6..0f836ed3f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ [![Discord][discord-image]][discord-url] [![NPM Package Downloads][npm-image-downloads]][npm-url] +### Reference Docs + 1. For SDK documentation, check out the [TypeScript SDK documentation](https://aptos.dev/sdks/new-ts-sdk/) + 2. For detailed reference documentation you can search, check out the [API reference documentation](https://aptos-labs.github.io/aptos-ts-sdk/) for the associated version. + 3. For in-depth examples, check out the [examples](./examples) folder with ready-made `package.json` files to get you going quickly! + ### Latest Version [![NPM Package Version][npm-image-version]][npm-url] @@ -169,12 +174,6 @@ const transaction = await aptos.transferCoinTransaction({ const pendingTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction }); ``` -## Documentation and examples - -- For full SDK documentation, check out the [TypeScript SDK documentation](https://aptos.dev/sdks/new-ts-sdk/) -- For reference documenation, check out the [API reference documentation](https://aptos-labs.github.io/aptos-ts-sdk/) for the associated version. -- For in-depth examples, check out the [examples](./examples) folder with ready-made `package.json` files to get you going quickly! - ### Testing To run the SDK tests, simply run from the root of this repository: