updated readme

readme.md

@@ -1,42 +1,27 @@
-==========
+# Allowances
-Allowances
-==========
 
-.. rubric:: keeping track of my children's money since 2013
+keeping track of my children's money since 2013
 
-Why
+## Why
-===
 
-I want to write a from-scratch, non-tutorial web application in go. This is my
+Originally I wanted to write a from-scratch, non-tutorial web application in
-attempt at such an endeavor.
+go. After a few years of writing web stuff in go. My wife came to rely on this
+and when she asked me to stand up the service again I couldn't get past how bad
+the code looked so I polished things up.
 
+## how
 
-What
+you can safely install this by running the following:
-====
 
-The main point of this app should be the following:
+    $ go get mcquay.me/allowances/...
-    * authenticate user(s)
-    * All should be able to see:
-        - how much each child has earned
-        - show results for a single child
-    * Authenticated users should be able to:
-        - add money to a given child by surfing to their page and clicking on
-          coins
-    * The app should:
-        - be resilient to restart
-            - on write, store info in .json db
-            - on start up deal with parsing and empty data.json files
-        - look better than what I've written in the past
 
-Dependencies
+One can initialize the password and children db as follows:
-============
-    * bootstrap_
-        - place in ./static/bootstrap
 
+    $ allowances pw add $PASS
+    $ allowances children add $DB a b c d
 
-Bootstrap DB
+and run the server as such:
-============
 
-$ echo "[]" > passwds.json
+    export PASSES=/tmp/passes.json
-
+    export DB=/tmp/children.json
-.. _bootstrap: http://twitter.github.com/bootstrap/assets/bootstrap.zip
+    allowances serve