diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-23 00:11:23 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-23 00:11:23 +0800 |
| commit | 289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5 (patch) | |
| tree | b2f8385600b43589f608c32b699c5f215b4276d5 /packages/web3-wrapper/README.md | |
| parent | 8478dc8d6d05efcdeac6653872f35149f3c9589c (diff) | |
| parent | 81f6487865faad641108a566f3f717311ee43a0b (diff) | |
| download | dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.gz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.bz2 dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.lz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.xz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.zst dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.zip | |
Merge pull request #465 from 0xProject/addExtraDocs
Add Additional Package Doc Pages
Diffstat (limited to 'packages/web3-wrapper/README.md')
| -rw-r--r-- | packages/web3-wrapper/README.md | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0d5defb1e..1fed11407 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,6 +1,8 @@ ## @0xproject/web3-wrapper -Wrapped version of web3 with a nicer interface that is used across 0x projects and packages +Wrapped version of web3 with a nicer interface that is used across 0x projects and packages. + +### Read the [Documentation](0xproject.com/docs/web3_wrapper). ## Installation @@ -16,16 +18,6 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ] ``` -## 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. |