Browse Source

updated readme

Stephen McQuay 4 years ago
parent
commit
f0a462447b
1 changed files with 17 additions and 32 deletions
  1. 17
    32
      readme.md

+ 17
- 32
readme.md View File

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

Loading…
Cancel
Save