update docs, dependencies #11

README.md

@@ -5,7 +5,7 @@ Server for connect to GitHub Issues API and displaying a burndown chart for a cu
 You can install all the following dependencies by running:
 
 ```bash
-npm install -d
+$ npm install -d
 ```
 
 - [CoffeeScript](http://coffeescript.org/)
@@ -23,12 +23,31 @@ github_project: 'InterMine'
 project_name:   'Core InterMine Project'
 ```
 
-Then, assign tickets to milestones and add labels to them in the format **size n**.
+The `project_name` key-value pair represents the title of the burndown chart that you will see in the top right corner of the page.
+
+### Milestones
+
+Then visit your GitHub project's Issues page and create a new milestone with a date due in the future. This will represent your iteration. This app will pick the Milestone with the **closest due date in the future** as the *current* one.
+
+### Sizes
+
+Then assign a few labels to tickets in this Milestone. These labels will represent your perceived size of the task. The label takes a form of *size [number]* so to say that an Issue is as big as *5* points I would create and assign this label (don't worry about the colors...):
+
+```
+size 5
+```
 
 ## Use:
 
-1. Start a node server using `.webserver.sh`
+```bash
-2. Visit [http://0.0.0.0:3000/](http://0.0.0.0:3000/)
+$ npm start
+```
+
+Then visit [http://127.0.0.1:3000/](http://127.0.0.1:3000/).
+
+There is nothing to save in a database so each refresh of the page fetches all of the latest information from GitHub.
+
+Enjoy!
 
 ## Example:
 

app.coffee

@@ -45,7 +45,7 @@ Issues =
         issue
 
 # Express.
-app = express.createServer()
+app = express()
 
 app.configure ->
     app.use express.logger()

config.yml

@@ -1,3 +1,3 @@
-github_user:    'intermine'
+github_user:    'radekstepan'
-github_project: 'InterMine'
+github_project: 'intermine-widget-client'
-project_name:   'Core InterMine Project'
+project_name:   'List Widgets'

package.json

@@ -1,10 +1,13 @@
 {
-  "name": "github-burndown-chart"
+    "name": "github-burndown-chart"
-  , "version": "0.0.0"
+    , "version": "0.1.0"
-  , "private": true
+    , "private": true
-  , "dependencies": {
+    , "dependencies": {
-    "express": ">= 3.0",
+        "coffee-script": "latest",
-    "eco":     "latest",
+        "express": ">= 3.0",
-    "js-yaml": "latest"
+        "eco": "latest",
-  }
+        "js-yaml": "latest"
+    }, "scripts": {
+        "start": "./node_modules/.bin/coffee app.coffee"
+    }
 }

webserver.sh

@@ -1 +0,0 @@
-coffee app.coffee