diff options
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/assert/README.md | 2 | ||||
| -rw-r--r-- | packages/json-schemas/README.md | 2 | ||||
| -rw-r--r-- | packages/tslint-config/README.md | 3 | ||||
| -rw-r--r-- | packages/web3-wrapper/README.md | 12 |
4 files changed, 13 insertions, 6 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md index 585b4f39e..40854cfa2 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -25,7 +25,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 ``` diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index 1c0d001b5..21ba92a37 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -32,7 +32,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 ``` diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index bbd0fb0f2..e943bc0db 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -11,6 +11,7 @@ yarn add --dev @0xproject/tslint-config ## Usage +Add the following to your `tslint.json` file ```json { "extends": [ @@ -27,7 +28,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 ``` 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 ``` |