aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-22 02:55:59 +0800
committerFabio Berger <me@fabioberger.com>2018-03-22 02:55:59 +0800
commite1341bc6d957d70a386c858cbdb64af5f284fd07 (patch)
tree5c6d76b4d179d51551c2bd051d48b04187033ef6 /packages/json-schemas/README.md
parentd437a660198a36c585f6cd5fe1bd13643da52ecb (diff)
downloaddexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.gz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.bz2
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.lz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.xz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.zst
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.zip
Move docs to page and add link to docs to README
Diffstat (limited to 'packages/json-schemas/README.md')
-rw-r--r--packages/json-schemas/README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index 754ce4e95..961c3746d 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
+npm install @0xproject/json-schemas --save
```
-## 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