aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-11-15 11:31:37 +0800
committerFabio Berger <me@fabioberger.com>2017-11-15 11:31:37 +0800
commit87f8e93e1284dd446d789320b651600b5c2a330f (patch)
tree270bb6445308687c5e176ebe869b9e28f5a44ec3 /README.md
parent5bd8e172c9415e9d8eca2d3893fe767684018351 (diff)
downloaddexon-sol-tools-87f8e93e1284dd446d789320b651600b5c2a330f.tar.gz
dexon-sol-tools-87f8e93e1284dd446d789320b651600b5c2a330f.tar.zst
dexon-sol-tools-87f8e93e1284dd446d789320b651600b5c2a330f.zip
Add core packes to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 8 insertions, 22 deletions
diff --git a/README.md b/README.md
index 789270d2a..aad89d2c5 100644
--- a/README.md
+++ b/README.md
@@ -17,25 +17,11 @@ This repository contains all the 0x developer tools written in TypeScript. Our h
[![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';
-```
+### Core Packages
+
+| Package | Version | Description |
+|--------|-------|------------|
+| [`0x.js`](/packages/0x.js) | [![npm](https://img.shields.io/npm/v/0x.js.svg?maxAge=2592000)](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol |
+| [`@0xproject/assert`](/packages/assert) | [![npm](https://img.shields.io/npm/v/@0xproject/assert.svg?maxAge=2592000)](https://www.npmjs.com/package/@0xproject/assert) | Standard type and schema assertions |
+| [`@0xproject/json-schemas`](/packages/json-schemas) | [![npm](https://img.shields.io/npm/v/@0xproject/json-schemas.svg?maxAge=2592000)](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas |
+| [`@0xproject/tslint-config`](/packages/tslint-config) | [![npm](https://img.shields.io/npm/v/@0xproject/tslint-config.svg?maxAge=2592000)](https://www.npmjs.com/package/@0xproject/tslint-config) | Custom 0x project TSLint rules |