aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-06-20 08:44:22 +0800
committerFabio Berger <me@fabioberger.com>2017-06-20 08:44:22 +0800
commitf86d177cd466246527729752b353c446676759d5 (patch)
tree8c6402e9b866e22f6494f6bb74298f6cc60ee6ad /README.md
parent999cf1be7cc7bef3c10fc68e097e70e5cd795ed6 (diff)
downloaddexon-sol-tools-f86d177cd466246527729752b353c446676759d5.tar.gz
dexon-sol-tools-f86d177cd466246527729752b353c446676759d5.tar.zst
dexon-sol-tools-f86d177cd466246527729752b353c446676759d5.zip
Add the installation instructions to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 32 insertions, 2 deletions
diff --git a/README.md b/README.md
index 50d6b442b..a37c13e80 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 0x enabled DApps ontop of the 0x protocol.
+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)
@@ -12,7 +12,37 @@ This repository contains a Javascript library that makes it easy to build Relaye
[![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)
-# [Read the docs][docs-url]
+## 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>
+```
+
+## [Browse the 0x.js documentation][docs-url]
[website-url]: https://0xproject.com/
[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf