diff options
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. [](https://circleci.com/gh/0xProject/0x.js) -[](https://coveralls.io/github/0xProject/0x.js?branch=master)
\ No newline at end of file +[](https://coveralls.io/github/0xProject/0x.js?branch=master) +[](http://slack.0xProject.com) +[](https://gitter.im/0xProject/contracts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[](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 |