Update README.md

README.md

@@ -1,33 +1,41 @@
-
 gitdone
-A todo list for git commits.
+=========================
+Plan your commits
+
+
+Purpose
+-------
+
+Found a bug in code unrelated to your pending commit? Plan the next commit with gitdone. Where `git log` displays past commits, gitdone is a list of future (planned) commits. Use gitdone to manage your next commit so you don't lose focus on the present.
 
 Simple usage example:
+---------------------
 
-$> gitdone add "Fix validation bug."
-$> gitdone list # outputs "Fix validation bug."
+Plan a commit:
 
-... make source code changes until ready to commit ...
+    $> gitdone add "Fix validation bug."
 
-$> gitdone commit # equivalent of 'git commit -am "Fix validation bug."'
-$> gitdone list # No tasks.
+See planned commits:
 
-Purpose:
+    $> gitdone list
+    Fix validation bug.
+    Accept command line parameter
+    Whitespace
+
+See next commit:
 
-gitdone provides a way to keep a todo list of commits you plan to make. Each entry (made with 'gitdone add <task>') becomes the commit message when 'gitdone commit' is used. 'gitdone list' lists all the tasks. The topmost task is the current task. It is the default commit message for 'gitdone commit', however any task can be specified by line number. For example:
+    $> gitdone next
+    Fix validation bug.
 
-$> gitdone add "task a"
-$> gitdone add "task b"
-$> gitdone add "task c"
-$> gitdone list
-0 task a
-1 task b
-2 task c
+Execute next commit:
 
-$> gitdone commit 2 # uses 'task c' as the commit message.
+    $> gitdone commit
+    # equivalent of 'git commit -am "Fix validation bug."'
 
-gitdone provides context. Interrupted? 'gitdone top' tells you what you're working on. Want to see what's next? 'gitdone list' shows all of your tasks. Need to re-prioritize? 'gitdone edit' opens your task list in your editor of choice.
-
+Edit plan:
+
+    $> gitdone edit
+    # opens $EDITOR with list of planned commits for editing / reordering.