Updated docs

package.json

@@ -6,10 +6,8 @@
   "dependencies": {
     "ecstatic": "~0.1.6",
     "node.io": "~0.4.12",
-    "async": "~0.1.22",
     "solr": "~0.2.2",
     "cheerio": "~0.10.1",
-    "request": "~2.11.4",
     "director": "~1.1.6",
     "union": "~0.3.4"
   },

readme.md

@@ -1 +1,46 @@
-A node js + solr + request + node.io + cheerio example for web scraping, data indexing and search
+Birds Search 
+====
+
+This is a sample repo of a work with the following libs/frameworks:
+
+* Node JS - Server side
+    * flatiron/director - Routing lib
+    * ecstatic - Serve static files
+    * cheerio - A jquery core selector implentation 
+    * Node.IO  - scraping lib (can be     removed..)
+    * node-solr - Apache Solr client
+* Apache Solr - search engine
+
+
+The flow of setting up the project is as follows:
+
+### 1 ###
+
+
+    node scrape
+
+This will start a process to scrape the list of birds recorded in israeli from: http://www.israbirding.com/checklist/ 
+
+Than, with a minor tweak on the bird names, it will scrape the relevant bird pages from wikipedia.
+
+### 2 ###
+
+    solr /path/to/config
+
+Make sure solr is up.
+
+### 3 ###
+
+    node solr-index
+
+process to pick up the files scraped from the web and create the solr documents
+
+### 4 ###
+
+    node app
+
+Start the web server
+
+You should now be able to http://127.0.0.1:8080/ locally and play around with the data
+
+