Merge pull request #218 from 0xProject/bmillman_add_assert

Add assert sub-package

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
index d63b0e070..ed126187e 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,26 @@ This repository contains all the 0x developer tools written in TypeScript. Our h
 [![Join the chat at https://gitter.im/0xProject/Lobby](https://badges.gitter.im/0xProject/Lobby.svg)](https://gitter.im/0xProject/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Greenkeeper badge](https://badges.greenkeeper.io/0xProject/0x.js.svg?token=7c22e5c72acf39d3ead8d29c5d9bb38f9096df3e643024dcedd53ab732847be1&ts=1496426342666)](https://greenkeeper.io/)
+
+Instructions
+------------
+
+Make sure you have `yarn@1.x` installed locally.
+
+### Creating a new sub-package
+
+1. Make sure the `name` field in the sub-package's `package.json` starts with `@0xproject/` and has a unique name (e.g `@0xproject/assert`).
+
+2. Run `yarn install` to install all it's dependencies.
+
+### How to add a sub-package as a dependency to another sub-package:
+
+1. Add the sub-packages name (declared in it's `package.json`) to your sub-packages `package.json` under `dependencies` or `devDependencies`.
+
+2. Run `yarn install` from anywhere in the mono repo.
+
+3. Import the sub-package as:
+
+```
+import {myPkg} from '@0xproject/myPkg';
+```