protocol/README.md

---

0x is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our whitepaper.

This repository contains all the 0x developer tools written in TypeScript. Our hope is that these tools make it easy to build Relayers and other DApps that use the 0x protocol.

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';