diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-21 06:24:26 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-21 06:24:26 +0800 |
| commit | 38f716bd77c46e55ad117cfef8cb42474e61a7c0 (patch) | |
| tree | 722860c90778fd9bb822c242ac4e81b70678e21a /packages | |
| parent | 6a410b03ff644ed46b4ae1e6f8bf81203deb1663 (diff) | |
| download | dexon-0x-contracts-38f716bd77c46e55ad117cfef8cb42474e61a7c0.tar.gz dexon-0x-contracts-38f716bd77c46e55ad117cfef8cb42474e61a7c0.tar.zst dexon-0x-contracts-38f716bd77c46e55ad117cfef8cb42474e61a7c0.zip | |
Make docs link more discoverable in README, move docs out of README
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/web3-wrapper/README.md | 14 | ||||
| -rw-r--r-- | packages/website/md/docs/web3_wrapper/installation.md | 8 |
2 files changed, 11 insertions, 11 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 244e20708..c63982703 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. Visit [the docs](0xproject.com/docs/web3_wrapper). +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. diff --git a/packages/website/md/docs/web3_wrapper/installation.md b/packages/website/md/docs/web3_wrapper/installation.md index 6e9b4cb59..92794d9b0 100644 --- a/packages/website/md/docs/web3_wrapper/installation.md +++ b/packages/website/md/docs/web3_wrapper/installation.md @@ -15,3 +15,11 @@ or ```javascript var Web3Wrapper = require('@0xproject/web3-wrapper').Web3Wrapper; ``` + +If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: + +``` +"include": [ + "./node_modules/web3-typescript-typings/index.d.ts", +] +``` |