68 lines
1016 B
Markdown
68 lines
1016 B
Markdown
## @0xproject/json-schemas
|
|
|
|
Contains 0x-related json schemas
|
|
|
|
### Read the [Documentation](0xproject.com/docs/json-schemas).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @0xproject/json-schemas --save
|
|
```
|
|
|
|
**Import**
|
|
|
|
```javascript
|
|
import { schemas } from '@0xproject/json-schemas';
|
|
```
|
|
|
|
or
|
|
|
|
```javascript
|
|
var schemas = require('@0xproject/json-schemas').schemas;
|
|
```
|
|
|
|
## 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.
|
|
|
|
Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
|
|
|
|
### Install Dependencies
|
|
|
|
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
|
|
|
|
```bash
|
|
yarn config set workspaces-experimental true
|
|
```
|
|
|
|
Then install dependencies
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
yarn build:watch
|
|
```
|
|
|
|
### Lint
|
|
|
|
```bash
|
|
yarn lint
|
|
```
|
|
|
|
### Run Tests
|
|
|
|
```bash
|
|
yarn test
|
|
```
|