diff options
author | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
commit | 972e1675f6490bc10e8d9fd64cce2f7945cd4840 (patch) | |
tree | 11bc2769c40cf38a62a5a305c0d36dc5a2baec12 | |
parent | 05ee36876386764c76aa0d2359ba17258152097d (diff) | |
parent | 291e2c8fa0214d35b3829d3503d7c9067b9e26db (diff) | |
download | dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.gz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.bz2 dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.lz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.xz dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.zst dexon-sol-tools-972e1675f6490bc10e8d9fd64cce2f7945cd4840.zip |
Merge branch 'development' of github.com:0xProject/0x.js into development
* 'development' of github.com:0xProject/0x.js:
Change contributing test
Fix yarn workspaces explanation
Change CONTRIBUTING section
Fix the headers
Address feedback
Write 4 README's
-rw-r--r-- | packages/assert/README.md | 50 | ||||
-rw-r--r-- | packages/json-schemas/README.md | 49 | ||||
-rw-r--r-- | packages/tslint-config/README.md | 57 | ||||
-rw-r--r-- | packages/web3-wrapper/README.md | 52 |
4 files changed, 191 insertions, 17 deletions
diff --git a/packages/assert/README.md b/packages/assert/README.md index b0dc9a451..052d56582 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -1,10 +1,54 @@ -assert +@0xproject/assert ------ Standard type and schema assertions to be used across all 0x projects and packages -## Install +## Installation ```bash -npm install @0xproject/assert --save +yarn add @0xproject/assert +``` + +## Usage + +```typescript +import {assert} from '@0xproject/assert'; + +assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount); +``` + +## 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. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test ``` diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index d89f57a5e..94dfd8640 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -1,16 +1,17 @@ -json-schemas ------------- +@0xproject/json-schemas +------ Contains 0x-related json schemas -## Install: +## Installation ```bash -npm install @0xproject/json-schemas --save +yarn add @0xproject/json-schemas ``` -## Usage: -``` +## Usage + +```javascript import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; const {orderSchema} = schemas; @@ -22,3 +23,39 @@ const order = { const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean ``` + +## 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. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index 38a6bce45..b27d05df0 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,10 +1,57 @@ -tslint-config -------------- +@0xproject/tslint-config +------ -Lint rules related to 0xProject for TSLint. +TSLint configuration and custom linter rules used by 0xProject. -## Install: +## Installation ```bash -npm install @0xproject/tslint-config --save-dev +yarn add --dev @0xproject/tslint-config +``` + +## Usage + +Add the following to your `tslint.json` file +```json +{ + "extends": [ + "@0xproject/tslint-config" + ] +} +``` + +## 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. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test ``` diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 0df8c6333..c6e2163a3 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,10 +1,56 @@ -Web3 wrapper +@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 -## Install +## Installation ```bash yarn add @0xproject/web3-wrapper ``` + +## 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. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install Dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` |