From 0b48e81f7947600b76fffa1301e94bdd6163d5a5 Mon Sep 17 00:00:00 2001
From: Radek Stepan <dev@radekstepan.com>
Date: Mon, 17 Sep 2012 09:11:27 +0100
Subject: [PATCH] update docs, dependencies #11

---
 README.md    | 27 +++++++++++++++++++++++----
 app.coffee   |  2 +-
 config.yml   |  6 +++---
 package.json | 19 +++++++++++--------
 webserver.sh |  1 -
 5 files changed, 38 insertions(+), 17 deletions(-)
 delete mode 100755 webserver.sh

diff --git a/README.md b/README.md
index 4c421ed..f744f30 100644
--- a/README.md
+++ b/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`
-2. Visit [http://0.0.0.0:3000/](http://0.0.0.0:3000/)
+```bash
+$ 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:
 
diff --git a/app.coffee b/app.coffee
index 2393fdb..43f7f1c 100644
--- a/app.coffee
+++ b/app.coffee
@@ -45,7 +45,7 @@ Issues =
         issue
 
 # Express.
-app = express.createServer()
+app = express()
 
 app.configure ->
     app.use express.logger()
diff --git a/config.yml b/config.yml
index 7c2c475..8a8266f 100644
--- a/config.yml
+++ b/config.yml
@@ -1,3 +1,3 @@
-github_user:    'intermine'
-github_project: 'InterMine'
-project_name:   'Core InterMine Project'
\ No newline at end of file
+github_user:    'radekstepan'
+github_project: 'intermine-widget-client'
+project_name:   'List Widgets'
\ No newline at end of file
diff --git a/package.json b/package.json
index 8170f02..98744ad 100644
--- a/package.json
+++ b/package.json
@@ -1,10 +1,13 @@
 {
-  "name": "github-burndown-chart"
-  , "version": "0.0.0"
-  , "private": true
-  , "dependencies": {
-    "express": ">= 3.0",
-    "eco":     "latest",
-    "js-yaml": "latest"
-  }
+    "name": "github-burndown-chart"
+    , "version": "0.1.0"
+    , "private": true
+    , "dependencies": {
+        "coffee-script": "latest",
+        "express": ">= 3.0",
+        "eco": "latest",
+        "js-yaml": "latest"
+    }, "scripts": {
+        "start": "./node_modules/.bin/coffee app.coffee"
+    }
 }
\ No newline at end of file
diff --git a/webserver.sh b/webserver.sh
deleted file mode 100755
index 57686d9..0000000
--- a/webserver.sh
+++ /dev/null
@@ -1 +0,0 @@
-coffee app.coffee
\ No newline at end of file