diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-03-27 23:47:45 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-27 23:47:45 +0800 |
| commit | 066d13f5b7260d28b13195c4f9aed48b4ae96cc3 (patch) | |
| tree | 5326f5b5789cc30ea6c5262a4ac19978737081ef /packages/json-schemas/README.md | |
| parent | 26e9696ddb004759a4a7c5f4a8901dc3255a70f9 (diff) | |
| parent | ec06d8d6067488b53183db392b4da91be0cc219e (diff) | |
| download | dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar.gz dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar.bz2 dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar.lz dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar.xz dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.tar.zst dexon-sol-tools-066d13f5b7260d28b13195c4f9aed48b4ae96cc3.zip | |
Merge pull request #480 from 0xProject/feature/clean-state-tests
Add clean-state tests
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. |