diff options
author | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
commit | 972e1675f6490bc10e8d9fd64cce2f7945cd4840 (patch) | |
tree | 11bc2769c40cf38a62a5a305c0d36dc5a2baec12 /packages/web3-wrapper/README.md | |
parent | 05ee36876386764c76aa0d2359ba17258152097d (diff) | |
parent | 291e2c8fa0214d35b3829d3503d7c9067b9e26db (diff) | |
download | dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.gz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.bz2 dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.lz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.xz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.zst dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.zip |
Merge branch 'development' of github.com:0xProject/0x.js into development
* 'development' of github.com:0xProject/0x.js:
Change contributing test
Fix yarn workspaces explanation
Change CONTRIBUTING section
Fix the headers
Address feedback
Write 4 README's
Diffstat (limited to 'packages/web3-wrapper/README.md')
-rw-r--r-- | packages/web3-wrapper/README.md | 52 |
1 files changed, 49 insertions, 3 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0df8c6333..c6e2163a3 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,10 +1,56 @@ -Web3 wrapper +@0xproject/web3-wrapper ------ -Wrapped version of web3 with nicer interface to be used across 0x projects and packages +Wrapped version of web3 with a nicer interface that is used across 0x projects and packages -## Install +## Installation ```bash yarn add @0xproject/web3-wrapper ``` + +## Usage + +```typescript +import {Web3Wrapper} from '@0xproject/web3-wrapper'; + +const web3 = ...; +const web3Wrapper = new Web3Wrapper(web3.currentProvider); +const availableAddresses = await web3Wrapper.getAvailableAddressesAsync(); +``` + +## Contributing + +We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` |