From 19a657c38b9fbe49ad8f4605d238f113d384941a Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Wed, 10 Oct 2018 22:40:14 +0200
Subject: Improve README

---
 packages/dev-tools-pages/README.md | 39 ++++++++++++++++++++++++++------------
 1 file changed, 27 insertions(+), 12 deletions(-)

(limited to 'packages/dev-tools-pages/README.md')

diff --git a/packages/dev-tools-pages/README.md b/packages/dev-tools-pages/README.md
index ce8edc103..b7bdf3bc3 100644
--- a/packages/dev-tools-pages/README.md
+++ b/packages/dev-tools-pages/README.md
@@ -2,23 +2,19 @@
 
 This repository contains our dev tools pages.
 
-## 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.
-
-Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
-
 ## Local Dev Setup
 
-Requires Node version 6.9.5 or higher
+Requires Node version 6.9.5 or higher & yarn v1.9.4
+
+### 1. Install dependencies for monorepo:
 
-### Install dependencies:
+Make sure you install Yarn v1.9.4 (npm won't work!). We rely on our `yarn.lock` file and on Yarn's support for `workspaces` in our monorepo setup.
 
 ```bash
 yarn install
 ```
 
-### Initial setup
+### 2. Initial setup
 
 To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
 
@@ -26,14 +22,19 @@ To build this package and all other monorepo packages that it depends on, run th
 PKG=@0xproject/dev-tools-pages yarn build
 ```
 
-### Run dev server
+Note: Ignore the `WARNING in asset size limit` and `WARNING in entrypoint size limit` warnings.
+
+### 3. Run dev server
 
 ```bash
-PKG=@0xproject/dev-tools-pages yarn watch
+cd packages/dev-tools-pages
+yarn dev
 ```
 
 Visit [http://localhost:3572/](http://localhost:3572/) in your browser.
 
+The webpage will refresh when source code is changed.
+
 ### Clean
 
 ```bash
@@ -46,14 +47,28 @@ yarn clean
 yarn lint
 ```
 
+### Prettier
+
+Run from the monorepo root directory:
+
+```
+yarn prettier
+```
+
 ### Resources
 
 ##### Toolkit
 
 *   [Styled Components](https://www.styled-components.com/)
-*   [Rebass](https://rebassjs.org/)
+*   [BassCSS](http://basscss.com/)
 
 ##### Recommended Atom packages:
 
 *   [atom-typescript](https://atom.io/packages/atom-typescript)
 *   [linter-tslint](https://atom.io/packages/linter-tslint)
+
+## 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.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
-- 
cgit v1.2.3