Merge pull request #214 from 0xProject/monoRepo

Switch over to Lerna + Yarn Workspaces setup for a mono-repo approach

1 files changed, 37 insertions, 0 deletions

diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
new file mode 100644
index 000000000..4b6cc8df4
--- /dev/null
+++ b/packages/0x.js/README.md
@@ -0,0 +1,37 @@
+## 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