Skip to content

Commit

Permalink
chore: make documentation and examples more prominent in README (#26498)
Browse files Browse the repository at this point in the history
* Make documentation and examples more prominent in README

There's a lot more documentation to this library than many users would see looking at the current README

- Make a dedicated 'Documentation and examples' heading
- Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top 
- Mention the examples higher up in the README

* Update web3.js/README.md

* Update web3.js/README.md
  • Loading branch information
mikemaccana committed Jul 8, 2022
1 parent 0d598b7 commit 5c6b178
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@

This is the Solana Javascript API built on the Solana [JSON RPC API](https://docs.solana.com/apps/jsonrpc-api)

[Latest API Documentation](https://solana-labs.github.io/solana-web3.js/)
## Documentation and examples

- [The Solana Cookbook](https://solanacookbook.com/) has extensive task-based documentation using this library.
- For more detail on individual functions, see the [latest API Documentation](https://solana-labs.github.io/solana-web3.js/)

## Installation

Expand Down Expand Up @@ -84,16 +87,6 @@ console.log(solanaWeb3);
console.log(solanaWeb3);
```

## Examples

Example scripts for the web3.js repo and native programs:

- [Web3 Examples](https://github.com/solana-labs/solana/tree/master/web3.js/examples)

Example scripts for the Solana Program Library:

- [Token Program Examples](https://github.com/solana-labs/solana-program-library/tree/master/token/js/examples)

## Flow Support (Discontinued)

Flow types are no longer supported in new releases. The last release with Flow support is v1.37.2 and its
Expand Down

0 comments on commit 5c6b178

Please sign in to comment.