From 71fd91255cbb451925f620261ff7ff3a8b8f1af2 Mon Sep 17 00:00:00 2001
From: Adrian Short <adrian.short@gmail.com>
Date: Fri, 17 Aug 2012 17:43:51 +0100
Subject: [PATCH] Improved README

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.md b/README.md
index 1f54c26..ea6b53f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
+Apollo
+======
+
+A [GeoRSS](http://en.wikipedia.org/wiki/GeoRSS) aggregator and augmented reality server for [Layar](http://layar.com/)
+
+© 2012 Adrian Short and Charlotte Gilhooly at [Headline Data](http://headlinedata.com/)
+
+This software was commissioned by [Talk About Local](http://talkaboutlocal.org.uk/) as part of the [HypARlocal](http://talkaboutlocal.org.uk/ar/) project.
+
+HypARlocal is funded by [NESTA](http://www.nesta.org.uk/destination_local) and the [Nominet Trust](http://www.nominettrust.org.uk/).
+
+What it does
+------------
+
+Periodically 
+
+Requirements
+------------
+
+* Rails 3
+* MongoDB
+* MongoMapper
+* Feedzilla
+
+
+Installation
+------------
+
 Before installing/deploying:
 
     $ export APOLLO_HOSTNAME=example.org
@@ -7,3 +35,14 @@ On Heroku:
     $ heroku config:add APOLLO_HOSTNAME=example.org
 
 Replace `example.org` with your own hostname. When running locally this will probably be `localhost:3000`.
+
+Set up a cron job or other scheduler to run
+
+    $ rake get_all_feeds
+    
+once per hour or to taste.
+
+Now create yourself a user account from the console:
+
+    $ rails c
+    > User.create :email => "me@example.org", :password => "verysecret", :password_confirmation => "verysecret"