diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-19 23:53:41 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-20 21:07:50 +0800 |
commit | de6fe257518e661b35df080ab54b1adc6819af5b (patch) | |
tree | 9af9fdad18d208ed6837630db3c9672ad1bdd591 /packages/json-schemas | |
parent | b603197ae837dca86d712760f9b18f626628096a (diff) | |
download | dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.gz dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.bz2 dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.lz dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.xz dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.tar.zst dexon-0x-contracts-de6fe257518e661b35df080ab54b1adc6819af5b.zip |
Write 4 README's
Diffstat (limited to 'packages/json-schemas')
-rw-r--r-- | packages/json-schemas/README.md | 37 |
1 files changed, 32 insertions, 5 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index d89f57a5e..4b4d148ed 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -1,16 +1,17 @@ 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,29 @@ 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 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` |