diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-23 00:11:23 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-23 00:11:23 +0800 |
| commit | 289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5 (patch) | |
| tree | b2f8385600b43589f608c32b699c5f215b4276d5 /packages/json-schemas/README.md | |
| parent | 8478dc8d6d05efcdeac6653872f35149f3c9589c (diff) | |
| parent | 81f6487865faad641108a566f3f717311ee43a0b (diff) | |
| download | dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.gz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.bz2 dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.lz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.xz dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.tar.zst dexon-sol-tools-289359bf0d1a4b5dd6d80a7e723bd92c46ffc1c5.zip | |
Merge pull request #465 from 0xProject/addExtraDocs
Add Additional Package Doc Pages
Diffstat (limited to 'packages/json-schemas/README.md')
| -rw-r--r-- | packages/json-schemas/README.md | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index 754ce4e95..f320196e9 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -2,25 +2,24 @@ Contains 0x-related json schemas +### Read the [Documentation](0xproject.com/docs/json-schemas). + ## Installation ```bash yarn add @0xproject/json-schemas ``` -## Usage +**Import** ```javascript -import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; +import { schemas } from '@0xproject/json-schemas'; +``` -const {orderSchema} = schemas; -const validator = new SchemaValidator(); +or -const order = { - ... -}; -const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors -const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean +```javascript +var schemas = require('@0xproject/json-schemas').schemas; ``` ## Contributing |