aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-11-22 04:03:08 +0800
committerFabio Berger <me@fabioberger.com>2017-11-22 04:03:08 +0800
commit3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b (patch)
treef101656799da807489253e17bea7abfaea90b62d /packages/website/README.md
parent037f466e1f80f635b48f3235258402e2ce75fb7b (diff)
downloaddexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar.gz
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar.bz2
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar.lz
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar.xz
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.tar.zst
dexon-sol-tools-3660ba28d73d70d08bf14c33ef680e5ef3ec7f3b.zip
Add website to mono repo, update packages to align with existing sub-packages, use new subscribeAsync 0x.js method
Diffstat (limited to 'packages/website/README.md')
-rw-r--r--packages/website/README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/packages/website/README.md b/packages/website/README.md
new file mode 100644
index 000000000..40df07cb7
--- /dev/null
+++ b/packages/website/README.md
@@ -0,0 +1,60 @@
+<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 our website and [0x Portal DApp][portal-url] (over-the-counter exchange), facilitating trustless over-the-counter trading of Ethereum-based tokens using 0x protocol.
+
+[website-url]: https://0xproject.com/
+[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf
+[portal-url]: https://0xproject.com/portal
+
+[![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)
+
+### Local Dev Setup
+
+Requires Node version 6.9.5 or higher.
+
+Add the following to your `/etc/hosts` file:
+
+```
+127.0.0.1 0xproject.dev
+```
+
+Clone the [0x contracts repo](https://github.com/0xProject/contracts) into the same parent directory as this project.
+
+Install [yarn](https://yarnpkg.com/lang/en/docs/install/) in order to install the project dependencies more deterministically.
+
+Install dependencies:
+
+```
+yarn
+```
+
+Import smart contract artifacts from `contracts` repo:
+
+```
+yarn run update_contracts
+```
+
+Start dev server:
+
+```
+yarn run dev
+```
+
+Visit [0xproject.dev:3572](http://0xproject.dev:3572) in your browser.
+
+
+##### Recommended Atom packages:
+
+- [atom-typescript](https://atom.io/packages/atom-typescript)
+- [linter-tslint](https://atom.io/packages/linter-tslint)
+
+##### Resources
+
+- [Material Design Icon Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html#directional)
+- [BassCSS toolkit](http://basscss.com/)
+- [Material-UI](http://www.material-ui.com/#/)