Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make documentation and examples more prominent in README #26498

Merged
merged 3 commits into from
Jul 8, 2022
Merged

Make documentation and examples more prominent in README #26498

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c8b97f
Make documentation and examples more prominent in README
mikemaccana Jul 8, 2022
e0e2c2b
Update web3.js/README.md
mikemaccana Jul 8, 2022
c593e86
Update web3.js/README.md
mikemaccana Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions web3.js/README.md
View file
Open in desktop
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