gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add more documentation

Browse Source
This commit is contained in:
Michael Vines 2018-08-22 20:06:29 -07:00
parent bf83497bbc
commit 0575148594
2 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
web3.js/CONTRIBUTING.md
View File

@ -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/ https://jestjs.io/
## API Documentation ## API Documentation

25
web3.js/README.md
View File

@ -7,13 +7,28 @@
This is the Solana Javascript API built on the Solana JSON RPC API (**TODO: add This is the Solana Javascript API built on the Solana JSON RPC API (**TODO: add
link**). link**).
[Latest API Documentation](https://solana-labs.github.io/solana-web3.js/) [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)