diff options
author | Fabio Berger <me@fabioberger.com> | 2017-11-14 07:20:20 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-11-14 07:20:20 +0800 |
commit | ee1a44ebebeb3ce1d4693c7162aea75de851e6d5 (patch) | |
tree | 4b55947a0cafef8b776c1e04477eab4fa3e92853 | |
parent | 5b70383ce6a195a093f0dab93d0704d2963bacc2 (diff) | |
download | dexon-0x-contracts-ee1a44ebebeb3ce1d4693c7162aea75de851e6d5.tar.gz dexon-0x-contracts-ee1a44ebebeb3ce1d4693c7162aea75de851e6d5.tar.zst dexon-0x-contracts-ee1a44ebebeb3ce1d4693c7162aea75de851e6d5.zip |
Add preliminary instructions to top-level README
-rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -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'; +``` |