aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-11-15 11:46:10 +0800
committerFabio Berger <me@fabioberger.com>2017-11-15 11:46:10 +0800
commit0cf719a744f5472483dafd0b21afd6b9167168d3 (patch)
tree66c56b5bf5811592e598b8873c685faa041a916d /packages
parent59f82c5bfb4a357d324011f5382340caef8e937f (diff)
downloaddexon-0x-contracts-0cf719a744f5472483dafd0b21afd6b9167168d3.tar.gz
dexon-0x-contracts-0cf719a744f5472483dafd0b21afd6b9167168d3.tar.zst
dexon-0x-contracts-0cf719a744f5472483dafd0b21afd6b9167168d3.zip
Add title and install instructions to all sub-package READMEs
Diffstat (limited to 'packages')
-rw-r--r--packages/0x.js/README.md3
-rw-r--r--packages/assert/README.md9
-rw-r--r--packages/json-schemas/README.md9
-rw-r--r--packages/tslint-config/README.md8
4 files changed, 28 insertions, 1 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
index 4b6cc8df4..6cdcbde70 100644
--- a/packages/0x.js/README.md
+++ b/packages/0x.js/README.md
@@ -1,3 +1,6 @@
+0x.js
+-----
+
## Installation
0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package.
diff --git a/packages/assert/README.md b/packages/assert/README.md
index 0c60671ea..b0dc9a451 100644
--- a/packages/assert/README.md
+++ b/packages/assert/README.md
@@ -1 +1,10 @@
+assert
+------
+
Standard type and schema assertions to be used across all 0x projects and packages
+
+## Install
+
+```bash
+npm install @0xproject/assert --save
+```
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index e9f80e106..d89f57a5e 100644
--- a/packages/json-schemas/README.md
+++ b/packages/json-schemas/README.md
@@ -1,5 +1,14 @@
+json-schemas
+------------
+
Contains 0x-related json schemas
+## Install:
+
+```bash
+npm install @0xproject/json-schemas --save
+```
+
## Usage:
```
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md
index d8bb0a51e..38a6bce45 100644
--- a/packages/tslint-config/README.md
+++ b/packages/tslint-config/README.md
@@ -1,4 +1,10 @@
tslint-config
------------------------
+-------------
Lint rules related to 0xProject for TSLint.
+
+## Install:
+
+```bash
+npm install @0xproject/tslint-config --save-dev
+```