Merge pull request #284 from 0xProject/feature/newAndImprovedReadmes

Improve/Add to README's

1 files changed, 35 insertions, 26 deletions

diff --git a/packages/website/README.md b/packages/website/README.md
index 40df07cb7..c050c6387 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,63 @@ 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)
+## Contributing
+
+We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
 
-### Local Dev Setup
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+## 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/#/)