blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
This commit is contained in:
Mike MacCana 2022-07-08 22:00:33 +01:00 committed by GitHub
parent c99d9f00a9
commit 6d7a569087
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
web3.js/README.md
View File

@ -23,7 +23,10 @@
This is the Solana Javascript API built on the Solana [JSON RPC API](https://docs.solana.com/apps/jsonrpc-api) 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 ## Installation
@ -84,16 +87,6 @@ console.log(solanaWeb3);
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 Support (Discontinued)
Flow types are no longer supported in new releases. The last release with Flow support is v1.37.2 and its Flow types are no longer supported in new releases. The last release with Flow support is v1.37.2 and its