aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/json-schemas/README.md')
-rw-r--r--packages/json-schemas/README.md50
1 files changed, 44 insertions, 6 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index d89f57a5e..9166f50c1 100644
--- a/packages/json-schemas/README.md
+++ b/packages/json-schemas/README.md
@@ -1,16 +1,16 @@
-json-schemas
-------------
+## @0xproject/json-schemas
Contains 0x-related json schemas
-## Install:
+## Installation
```bash
-npm install @0xproject/json-schemas --save
+yarn add @0xproject/json-schemas
```
-## Usage:
-```
+## Usage
+
+```javascript
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
const {orderSchema} = schemas;
@@ -22,3 +22,41 @@ const order = {
const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors
const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean
```
+
+## 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
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```