From 6d7a569087ee9cc3fa47232fb5b012937c6d1cba Mon Sep 17 00:00:00 2001 From: Mike MacCana Date: Fri, 8 Jul 2022 22:00:33 +0100 Subject: [PATCH] chore: make documentation and examples more prominent in README (#26498) * 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 --- web3.js/README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/web3.js/README.md b/web3.js/README.md index f0cfd61edb..1b07c4b6cc 100644 --- a/web3.js/README.md +++ b/web3.js/README.md @@ -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 @@ -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