Skip to content

Commit

Permalink
Make reference docs very prominent in the README (#346)
Browse files Browse the repository at this point in the history
* Update README.md

Add the link to the reference docs very clearly in the README

* Move old reference docs section up
  • Loading branch information
jmintuitive authored Apr 1, 2024
1 parent 7d257b7 commit 48749cf
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 48749cf

Please sign in to comment.