updated README

bcantin · Apr 23, 2011 · 5698a03 · 5698a03
1 parent 8262065
commit 5698a03
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 10 deletions.
diff --git a/README b/README
diff --git a/README.rdoc b/README.rdoc
@@ -0,0 +1,22 @@
+== TODO APP
+
+A command line todo creator for the TODO web app.
+
+Instructions:
+
+    - install and configure the TODO rails app
+    - install this app
+    - setup the config.yml for this app
+    - update your paths (~/bin/todo_app)
+
+USAGE:
+in any directory
+
+    todo your happy message
+
+## upcoming changes (for those bawler to use this right now...)
+- change the command line to accept arguements
+
+    -m 'message'
+    -p 'the project' (defaults to the current path || 'general') 
+    -h help (this stuff)