From c4ee2d73865a1444c079b9e2836b7630a0adf03e Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Sun, 12 Nov 2017 22:17:18 -0500 Subject: Switch over to Lerna + Yarn Workspaces setup for a mono-repo approach --- README.md | 40 +--------------------------------------- 1 file changed, 1 insertion(+), 39 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6eb5bb674..d63b0e070 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [0x][website-url] 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][whitepaper-url]. -This repository contains a Javascript library that makes it easy to build Relayers and other DApps that use the 0x protocol. +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. [![CircleCI](https://circleci.com/gh/0xProject/0x.js.svg?style=svg&circle-token=61bf7cd8c9b4e11b132089dfcffdd1be277d1e0c)](https://circleci.com/gh/0xProject/0x.js) [![npm version](https://badge.fury.io/js/0x.js.svg)](https://badge.fury.io/js/0x.js) @@ -13,41 +13,3 @@ This repository contains a Javascript library that makes it easy to build Relaye [![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/) - -## Installation - -0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package. - -#### CommonJS *(recommended)*: - -**Install** - -```bash -npm install 0x.js --save -``` - -**Import** - -```javascript -import {ZeroEx} from '0x.js'; -``` - -#### UMD: - -**Install** - -Download the UMD module from our [releases page](https://github.com/0xProject/0x.js/releases) and add it to your project. - -**Import** - -```html - -``` - -## Documentation - -Extensive documentation of 0x.js can be found on [our website][docs-url]. - -[website-url]: https://0xproject.com/ -[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf -[docs-url]: https://0xproject.com/docs/0xjs -- cgit