Merge pull request #71 from pdehaan/readmemd

Converting README from .rst to .md

.eslintrc

@@ -8,6 +8,7 @@ globals:
 
 rules:
   global-strict: 0
+  no-alert: 1
   no-process-exit: 0
   no-shadow: 0
   no-unused-vars: [1, {args: none}]

.travis.yml

@@ -1,5 +1,7 @@
 language: node_js
 
 node_js:
-  - 0.10
-  - 0.12
+  - "0.10"
+  - "0.12"
+
+sudo: false

README.md

@@ -0,0 +1,51 @@
+# loads-web
+
+[![Build Status](https://travis-ci.org/loads/loads-web.svg?branch=master)](https://travis-ci.org/loads/loads-web)
+
+Web dashboard for Loads, v2.
+<https://github.com/loads/loads-broker>
+
+ * Monitors active loadtests
+ * View historic loadtest runs
+ * Define load profiles (container sets)
+ * Control load test runs
+
+
+## Development
+
+Setting the app up:
+
+```sh
+$ npm install
+```
+
+Watch and compile Stylus to CSS:
+
+```sh
+$ ./node_modules/.bin/stylus --watch --compress client/static/assets/stylus/app.styl --out client/static/assets/css/
+```
+
+Starting the server:
+```sh
+$ node server # or `npm start`
+```
+
+
+## Deployment
+
+The dashboard is hosted by a Hapi server that proxies API requests to a
+separate broker instance. This allows the front-end to be developed
+independently of the broker, and provides a mechanism for serving mock data
+if the broker does not implement a particular call.
+
+You can use [awsbox](https://github.com/mozilla/awsbox) to deploy the Hapi
+server to AWS:
+
+```sh
+# Create the instance.
+> AWS_REGION=us-west-2 AWS_ID={id} AWS_SECRET={secret} \
+  [email protected] awsbox create -n loads-web
+
+# Deploy committed changes.
+> git push loads-web HEAD:master
+```