diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-03-24 02:18:31 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-24 02:18:31 +0800 |
| commit | f30353087f9c4ec4fa5e096a065c9749e1164984 (patch) | |
| tree | 4d7968160890b5efa358593e743411c7b8652556 /packages/json-schemas/README.md | |
| parent | 7ef6bd4b14b7502617c6929010d4a9991e1d577d (diff) | |
| parent | bed7d87b7ff64989051e6b2115a1c77e1e72ff55 (diff) | |
| download | dexon-0x-contracts-f30353087f9c4ec4fa5e096a065c9749e1164984.tar.gz dexon-0x-contracts-f30353087f9c4ec4fa5e096a065c9749e1164984.tar.zst dexon-0x-contracts-f30353087f9c4ec4fa5e096a065c9749e1164984.zip | |
Merge branch 'development' into feature/deployer-improvements
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 |