aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-20 09:49:36 +0800
committerFabio Berger <me@fabioberger.com>2017-12-20 09:49:36 +0800
commitdd39fadce7917d946f1d56ed19defaa2d68e26a5 (patch)
tree0d12991cc922b0cd8928e3ca6e0be643f64e22d0 /packages/website/README.md
parent5d240222093dafd9c9d2db24e66668b4214c1b8e (diff)
downloaddexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar.gz
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar.bz2
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar.lz
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar.xz
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.tar.zst
dexon-sol-tools-dd39fadce7917d946f1d56ed19defaa2d68e26a5.zip
Update and improve website README
Diffstat (limited to 'packages/website/README.md')
-rw-r--r--packages/website/README.md56
1 files changed, 30 insertions, 26 deletions
diff --git a/packages/website/README.md b/packages/website/README.md
index 40df07cb7..53cdbd8d3 100644
--- a/packages/website/README.md
+++ b/packages/website/README.md
@@ -1,8 +1,5 @@
-<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].
+Website & 0x Portal DApp
+-----
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.
@@ -10,51 +7,58 @@ This repository contains our website and [0x Portal DApp][portal-url] (over-the-
[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
+## 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
+127.0.0.1 0xproject.localhost
```
-Clone the [0x contracts repo](https://github.com/0xProject/contracts) into the same parent directory as this project.
+### Install dependencies:
-Install [yarn](https://yarnpkg.com/lang/en/docs/install/) in order to install the project dependencies more deterministically.
+```bash
+yarn install
+```
-Install dependencies:
+### Run dev server
-```
-yarn
+```bash
+yarn run dev
```
-Import smart contract artifacts from `contracts` repo:
+Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser.
-```
-yarn run update_contracts
+### Build
+
+```bash
+yarn build
```
-Start dev server:
+### Clean
+```bash
+yarn clean
```
-yarn run dev
+
+### Lint
+
+```bash
+yarn lint
```
-Visit [0xproject.dev:3572](http://0xproject.dev:3572) in your browser.
+### Resources
+
+##### Toolkit
+- [Material Design Icon Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html#directional)
+- [BassCSS toolkit](http://basscss.com/)
+- [Material-UI component library](http://www.material-ui.com/#/)
##### 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/#/)