Add more documentation
This commit is contained in:
parent
bf83497bbc
commit
0575148594
|
@ -1,5 +1,10 @@
|
|||
|
||||
## Test framework
|
||||
## Static Analysis
|
||||
eslint and flow-type are used.
|
||||
|
||||
Helpful link: https://www.saltycrane.com/flow-type-cheat-sheet/latest/
|
||||
|
||||
## Testing Framework
|
||||
https://jestjs.io/
|
||||
|
||||
## API Documentation
|
||||
|
|
|
@ -7,13 +7,28 @@
|
|||
This is the Solana Javascript API built on the Solana JSON RPC API (**TODO: add
|
||||
link**).
|
||||
|
||||
|
||||
[Latest API Documentation](https://solana-labs.github.io/solana-web3.js/)
|
||||
|
||||
|
||||
# Features
|
||||
...
|
||||
## Getting started
|
||||
|
||||
# Getting started
|
||||
...
|
||||
```
|
||||
$ npm install --save @solana/web3.js
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
See the [examples/](https://github.com/solana-labs/solana-web3.js/tree/master/examples)
|
||||
for simple examples of using the API from node.
|
||||
|
||||
Browser-based examples are also available:
|
||||
* Account creation - https://jsfiddle.net/mvines/sz4pco6y/
|
||||
|
||||
## Releases
|
||||
|
||||
Releases are available on [Github](https://github.com/solana-labs/solana-web3.js/releases)
|
||||
and [npmjs.com](https://www.npmjs.com/package/@solana/web3.js).
|
||||
|
||||
Each Github release features a tarball containing the API documentation release
|
||||
and a minified version of the module suitable for direct use in a browser
|
||||
environment (<script> tag)
|
||||
|
|
Loading…
Reference in New Issue