From 2c8b97ff4bd900586d92d2313f27e4b1466d0b8e Mon Sep 17 00:00:00 2001 From: Mike MacCana Date: Fri, 8 Jul 2022 10:59:17 +0100 Subject: [PATCH 1/3] 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 --- web3.js/README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/web3.js/README.md b/web3.js/README.md index f0cfd61edb3b61..52f315b5d4af32 100644 --- a/web3.js/README.md +++ b/web3.js/README.md @@ -23,7 +23,12 @@ 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/) + - [Web3 Examples](https://github.com/solana-labs/solana/tree/master/web3.js/examples) + - [Token Program Examples](https://github.com/solana-labs/solana-program-library/tree/master/token/js/examples) ## Installation @@ -84,16 +89,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 From e0e2c2b2e663ab41516965657aef4e07dc6f4a0a Mon Sep 17 00:00:00 2001 From: Mike MacCana Date: Fri, 8 Jul 2022 16:13:15 +0100 Subject: [PATCH 2/3] Update web3.js/README.md --- web3.js/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/web3.js/README.md b/web3.js/README.md index 52f315b5d4af32..dbd0d937ebe3c0 100644 --- a/web3.js/README.md +++ b/web3.js/README.md @@ -28,7 +28,6 @@ This is the Solana Javascript API built on the Solana [JSON RPC API](https://doc - [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/) - [Web3 Examples](https://github.com/solana-labs/solana/tree/master/web3.js/examples) - - [Token Program Examples](https://github.com/solana-labs/solana-program-library/tree/master/token/js/examples) ## Installation From c593e86d75c87633c962ed3da80421cc59bb7b0e Mon Sep 17 00:00:00 2001 From: Mike MacCana Date: Fri, 8 Jul 2022 16:13:20 +0100 Subject: [PATCH 3/3] Update web3.js/README.md --- web3.js/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/web3.js/README.md b/web3.js/README.md index dbd0d937ebe3c0..1b07c4b6cc32ba 100644 --- a/web3.js/README.md +++ b/web3.js/README.md @@ -27,7 +27,6 @@ This is the Solana Javascript API built on the Solana [JSON RPC API](https://doc - [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/) - - [Web3 Examples](https://github.com/solana-labs/solana/tree/master/web3.js/examples) ## Installation