From 0575148594cd6e18c8fb407c8edf4cb529d97d55 Mon Sep 17 00:00:00 2001 From: Michael Vines Date: Wed, 22 Aug 2018 20:06:29 -0700 Subject: [PATCH] Add more documentation --- web3.js/CONTRIBUTING.md | 7 ++++++- web3.js/README.md | 25 ++++++++++++++++++++----- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/web3.js/CONTRIBUTING.md b/web3.js/CONTRIBUTING.md index 4e0c22ad35..39f7fb205b 100644 --- a/web3.js/CONTRIBUTING.md +++ b/web3.js/CONTRIBUTING.md @@ -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 diff --git a/web3.js/README.md b/web3.js/README.md index e5fe722871..695916032c 100644 --- a/web3.js/README.md +++ b/web3.js/README.md @@ -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)