diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 8 insertions, 22 deletions
@@ -17,25 +17,11 @@ This repository contains all the 0x developer tools written in TypeScript. Our h [](https://opensource.org/licenses/Apache-2.0) [](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'; -``` +### Core Packages + +| Package | Version | Description | +|--------|-------|------------| +| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol | +| [`@0xproject/assert`](/packages/assert) | [](https://www.npmjs.com/package/@0xproject/assert) | Standard type and schema assertions | +| [`@0xproject/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas | +| [`@0xproject/tslint-config`](/packages/tslint-config) | [](https://www.npmjs.com/package/@0xproject/tslint-config) | Custom 0x project TSLint rules | |