diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-28 02:16:13 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-28 02:16:13 +0800 |
| commit | 005376276098a4e6cb832eaf5b5dbc07118e1f50 (patch) | |
| tree | 543a431a5fd2a17f3b3582cfb0910f8c85357ac1 /packages/json-schemas/README.md | |
| parent | eb89ef79eba3d044e10b8e52e20927bb88241ac2 (diff) | |
| parent | 066d13f5b7260d28b13195c4f9aed48b4ae96cc3 (diff) | |
| download | dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.gz dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.bz2 dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.lz dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.xz dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.tar.zst dexon-sol-tools-005376276098a4e6cb832eaf5b5dbc07118e1f50.zip | |
merge developmentx
Diffstat (limited to 'packages/json-schemas/README.md')
| -rw-r--r-- | packages/json-schemas/README.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index f320196e9..980d17416 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -12,8 +12,8 @@ yarn add @0xproject/json-schemas **Import** -```javascript -import { schemas } from '@0xproject/json-schemas'; +```typescript +import { SchemaValidator, ValidatorResult, schemas } from '@0xproject/json-schemas'; ``` or @@ -22,6 +22,14 @@ or var schemas = require('@0xproject/json-schemas').schemas; ``` +If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: + +```json +"compilerOptions": { + "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], +} +``` + ## 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. |