Added scripts documentation. Enabled deployment of example to github pages and deployed it. Updated demo link in README, also updated TOC

Author: rohan-deshpande

README.md

@@ -11,7 +11,9 @@ For those that haven't used or seen dat.GUI before, it's basically a GUI for upd
 - [Usage](#usage)
 - [Docs](#docs)
   * [`DatGui`](#datgui)
+    + [props](#props)
   * [Components](#components)
+    + [Common props](#common-props)
     + [`DatBoolean`](#datboolean)
     + [`DatButton`](#datbutton)
     + [`DatColor`](#datcolor)
@@ -20,14 +22,26 @@ For those that haven't used or seen dat.GUI before, it's basically a GUI for upd
     + [`DatPresets`](#datpresets)
     + [`DatSelect`](#datselect)
     + [`DatString`](#datstring)
+- [Scripts](#scripts)
+    + [`build`](#build)
+    + [`dev`](#dev)
+    + [`dev:migrate`](#devmigrate)
+    + [`dev:promote`](#devpromote)
+    + [`example`](#example)
+    + [`example:deploy`](#exampledeploy)
+    + [`test`](#test)
+    + [`test:watch`](#testwatch)
+    + [`lint`](#lint)
+    + [`lint:fix`](#lintfix)
+    + [`toc`](#toc)
 - [What's missing](#whats-missing)
 - [Roadmap](#roadmap)
 
 ## Demo
 
-[Checkout the demo!](http://rohandeshpande.com/react-dat-gui)
+[Checkout the demo!](https://rohan-deshpande.github.io/react-dat-gui/)
 
-The demo is a deployed version of the latest production build of `./example`.
+The demo is a deployed version of the latest production build of `./example`. There's also a `dev` directory where you can prototype changes to the source code easily. Both of these have been bootstrapped with `create-react-app`.
 
 ## Installation
 
@@ -183,6 +197,54 @@ A select component for updating a value with one of the options supplied via the
 
 A simple text input component that can be used to mutate strings.
 
+## Scripts
+
+There are a few NPM scripts in the root `package.json` for developing changes to the repo's source code as well as running tests and deploying the demo.
+
+#### `build`
+
+Builds the package for publishing.
+
+#### `dev`
+
+Runs the app in `./dev`.
+
+#### `dev:migrate`
+
+Migrates the code in `./src` to `./dev/src/react-dat-gui`. Handy for making sure you're developing with the latest source code.
+
+#### `dev:promote`
+
+Promotes the code in `./dev/src/react-dat-gui` back up to the root of the repo. Use this when you're happy with the changes you've been developing.
+
+#### `example`
+
+Runs the app in `./example`.
+
+#### `example:deploy`
+
+Deploys the production build of the app in `./example` to the `gh-pages` branch of this repo.
+
+#### `test`
+
+Runs unit tests.
+
+#### `test:watch`
+
+Runs unit tests and watches for changes.
+
+#### `lint`
+
+Runs `eslint` on the supplied path.
+
+#### `lint:fix`
+
+Runs `eslint --fix` on the supplied path.
+
+#### `toc`
+
+Prints the `README.md` table of contents into the console.
+
 ## What's missing
 
 There are still a few features from the original implementation missing from this package. These are mainly related to saving and loading data as well as local storage. Animations for folder expanding/collapsing is also not currently implemented, but shouldn't be too hard to do.

example/package-lock.json

@@ -1,5 +1,6 @@
 {
   "name": "react-dat-gui-example",
+  "homepage": "https://rohan-deshpande.github.io/react-dat-gui",
   "version": "0.1.0",
   "private": true,
   "dependencies": {
@@ -12,6 +13,11 @@
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test --env=jsdom",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "predeploy": "npm run build",
+    "deploy": "gh-pages -d build"
+  },
+  "devDependencies": {
+    "gh-pages": "^1.0.0"
   }
 }

example/package.json

@@ -31,10 +31,12 @@
     "dev:migrate": "sh scripts/dev-migrate && npm run dev",
     "dev:promote": "sh scripts/dev-promote && npm run build",
     "example": "npm run start --prefix example",
+    "example:deploy": "npm run deploy --prefix example",
     "test": "mocha --compilers js:babel-core/register --colors ./test/*.spec.js",
     "test:watch": "mocha --compilers js:babel-core/register --colors -w ./test/*.spec.js",
     "lint": "eslint src test build",
-    "lint:fix": "eslint --fix"
+    "lint:fix": "eslint --fix",
+    "toc": "markdown-toc README.md --no-firsth1 --maxdepth 3"
   },
   "dependencies": {
     "classnames": "2.2.5",