From de6fe257518e661b35df080ab54b1adc6819af5b Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 16:53:41 +0100 Subject: Write 4 README's --- packages/web3-wrapper/README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0df8c6333..04f2b8ca0 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -3,8 +3,38 @@ Web3 wrapper Wrapped version of web3 with nicer interface to be used across 0x projects and packages -## Install +## Installation ```bash yarn add @0xproject/web3-wrapper ``` + +## Usage + +TODO - Custom documentation page is in progress. + +## Contributing + +We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +[CONTRIBUTING.md](../../CONTRIBUTING.md) + +## Install Dependencies + +If you don't have yarn workspaces enabled - enable them: +`yarn config set workspaces-experimental true` + +Then install dependencies +`yarn install` + +## Build + +`yarn build` + +## Lint + +`yarn lint` + +## Run Tests + +`yarn test` -- cgit v1.2.3 From ecc6cb2b7c8aff181341474830cd482579db7ca1 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 18:03:44 +0100 Subject: Address feedback --- packages/web3-wrapper/README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 04f2b8ca0..db879d3cf 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -19,22 +19,32 @@ We strongly encourage our community members to help us make improvements and to [CONTRIBUTING.md](../../CONTRIBUTING.md) -## Install Dependencies +### Install Dependencies If you don't have yarn workspaces enabled - enable them: -`yarn config set workspaces-experimental true` +```bash +yarn config set workspaces-experimental true +``` Then install dependencies -`yarn install` +```bash +yarn install +``` -## Build +### Build -`yarn build` +```bash +yarn build +``` -## Lint +### Lint -`yarn lint` +```bash +yarn lint +``` -## Run Tests +### Run Tests -`yarn test` +```bash +yarn test +``` -- cgit v1.2.3 From 3579f063d6fb09f7a091d3f896bd29edb84b3f55 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 18:04:42 +0100 Subject: Fix the headers --- packages/web3-wrapper/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index db879d3cf..c8a984435 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,4 +1,4 @@ -Web3 wrapper +@0xproject/web3-wrapper ------ Wrapped version of web3 with nicer interface to be used across 0x projects and packages -- cgit v1.2.3 From c3508dcdc6e2cf459bf076c0bb0087338cf96f7a Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:10:35 +0100 Subject: Change CONTRIBUTING section --- packages/web3-wrapper/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index c8a984435..3624cea8c 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -17,7 +17,7 @@ TODO - Custom documentation page is in progress. We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. -[CONTRIBUTING.md](../../CONTRIBUTING.md) +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. ### Install Dependencies -- cgit v1.2.3 From 8ed776e113f0e249d50aa9e74b459b770ff62cee Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:17:17 +0100 Subject: Fix yarn workspaces explanation --- packages/web3-wrapper/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'packages/web3-wrapper') 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 ``` -- cgit v1.2.3 From bf1603839ee5b7e8a1b1db32a0d037b3680a38d6 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:21:39 +0100 Subject: Change contributing test --- packages/web3-wrapper/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 2aac1124b..c6e2163a3 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -21,7 +21,7 @@ const availableAddresses = await web3Wrapper.getAvailableAddressesAsync(); ## Contributing -We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. +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. -- cgit v1.2.3