diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-20 21:17:17 +0800 |
|---|---|---|
| committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-20 21:17:17 +0800 |
| commit | 8ed776e113f0e249d50aa9e74b459b770ff62cee (patch) | |
| tree | 2e626e28cf719b63c9cef04afb13a7ccb62c01c9 /packages/web3-wrapper/README.md | |
| parent | c3508dcdc6e2cf459bf076c0bb0087338cf96f7a (diff) | |
| download | dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar.gz dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar.bz2 dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar.lz dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar.xz dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.tar.zst dexon-sol-tools-8ed776e113f0e249d50aa9e74b459b770ff62cee.zip | |
Fix yarn workspaces explanation
Diffstat (limited to 'packages/web3-wrapper/README.md')
| -rw-r--r-- | packages/web3-wrapper/README.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 3624cea8c..2aac1124b 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,7 +1,7 @@ @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 ## Installation @@ -11,7 +11,13 @@ yarn add @0xproject/web3-wrapper ## Usage -TODO - Custom documentation page is in progress. +```typescript +import {Web3Wrapper} from '@0xproject/web3-wrapper'; + +const web3 = ...; +const web3Wrapper = new Web3Wrapper(web3.currentProvider); +const availableAddresses = await web3Wrapper.getAvailableAddressesAsync(); +``` ## Contributing @@ -21,7 +27,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting ### Install Dependencies -If you don't have yarn workspaces enabled - enable them: +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: ```bash yarn config set workspaces-experimental true ``` |