diff options
author | Fabio Berger <me@fabioberger.com> | 2017-06-20 08:51:03 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-06-20 08:51:03 +0800 |
commit | 6aaa7a08564c48dab7b7f7749792f61ffda376e7 (patch) | |
tree | 814daecab82a5220f6ccb3f89f43a0dd7a201d23 /README.md | |
parent | 20f59d556da11fa1c5c5c2f36ab467579b06d9a5 (diff) | |
parent | 8135f98029ce703b11d053e1a7c2a55e688b8d42 (diff) | |
download | dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar.gz dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar.bz2 dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar.lz dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar.xz dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.tar.zst dexon-sol-tools-6aaa7a08564c48dab7b7f7749792f61ffda376e7.zip |
Merge pull request #69 from 0xProject/improveReadme
Improve README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 51 |
1 files changed, 49 insertions, 2 deletions
@@ -1,4 +1,51 @@ -# 0x.js +<img src="https://github.com/0xProject/branding/blob/master/0x_Black_CMYK.png" width="200px" > + +--- + +[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. [![CircleCI](https://circleci.com/gh/0xProject/0x.js.svg?style=svg&circle-token=61bf7cd8c9b4e11b132089dfcffdd1be277d1e0c)](https://circleci.com/gh/0xProject/0x.js) -[![Coverage Status](https://coveralls.io/repos/github/0xProject/0x.js/badge.svg?branch=master&t=fp0cXD)](https://coveralls.io/github/0xProject/0x.js?branch=master)
\ No newline at end of file +[![Coverage Status](https://coveralls.io/repos/github/0xProject/0x.js/badge.svg?branch=master&t=fp0cXD)](https://coveralls.io/github/0xProject/0x.js?branch=master) +[![Slack Status](http://slack.0xProject.com/badge.svg)](http://slack.0xProject.com) +[![Join the chat at https://gitter.im/0xProject/contracts](https://badges.gitter.im/0xProject/contracts.svg)](https://gitter.im/0xProject/contracts?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) + +## 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 +<script type="text/javascript" src="0x.js"></script> +``` + +## 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 |