From 3a1f4027c36f16385e8d079c58a4c4d291505457 Mon Sep 17 00:00:00 2001
From: Chris Stucchio <stucchio@gmail.com>
Date: Sun, 3 Oct 2010 17:56:59 -0400
Subject: [PATCH] Updated docs. Solves #15, improves #2.

---
 readme.rst | 64 +++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 54 insertions(+), 10 deletions(-)

diff --git a/readme.rst b/readme.rst
index 52bc828..d1ed731 100644
--- a/readme.rst
+++ b/readme.rst
@@ -77,19 +77,66 @@ Using
 To add a bug::
 
     $ idli add --title "title of bug" --body "body of bug."
+    Issue added!
 
-To list existing bugs::
+    ID: 33
+    Title: title of bug
+    Creator: stucchio
+    Create time: 2010-10-03 14:35:28
+    Open: True
+
+    body of bug.
 
-    $ idli list
-    ID:date              title                      creator                    # comments
-    11:<2010/09/21 03:26>  Frobnicator broken         stucchio                   0
-    12:<2010/09/21 03:27>  Widgets full of beer       stucchio                   0
-    13:<2010/09/21 03:27>  Documentation confusing    stucchio                   0
 
 If the title and body are unspecified, idli will open an editor for you to type them.
 The specific editor used can be configured via the EDITOR environment variable (note that
 git uses the same variable).
 
+To tag a bug::
+
+    $ ./scripts/idli tag 33 demo
+    ID: 33
+    Title: title of bug
+    Creator: stucchio
+    Create time: 2010-10-03 14:35:28
+    Open: True
+    Tags: demo
+
+    body of bug.
+
+Bugs can also be tagged when created with `idli add --tags=foo,bar` - the resulting issue will have both the tags `foo` and `bar`.
+
+To list existing bugs::
+
+    $ idli list
+    ID     date        title                                creator       owner       # comments
+    11     2010/10/02  warp drive is broken                 kirk                      0
+    31     2010/10/03  frobnicator is broken                stucchio      stucchio    0
+    32     2010/10/03  beer in the widgets                  stucchio      homer       3
+    35     2010/10/03  beer in the frobnicator              stucchio      homer       4
+    38     2010/10/03  title of bug                         stucchio                  0
+
+To assign a bug::
+
+    $ idli assign 11 scotty --message "I need warp drive now."
+
+To comment on an issue::
+
+    $ idli comment 11 --body "Keptin, I canna change the laws of physics!"
+
+To list issues owned by you (not supported by all backends)::
+
+    $ idli list --mine
+    ID     date        title                                creator       owner       # comments
+    31     2010/10/03  frobnicator is broken                stucchio      stucchio    0
+
+To list issues with a given tag::
+
+    $ idli list --tag=beer
+    ID     date        title                                creator       owner       # comments
+    32     2010/10/03  beer in the widgets                  stucchio      homer       3
+    35     2010/10/03  beer in the frobnicator              stucchio      homer       4
+
 To view a bug in more detail::
 
     $ idli show 11
@@ -98,6 +145,7 @@ To view a bug in more detail::
     Creator: stucchio
     Create time: 2010-09-21 03:26:57
     Open: True
+    Tags: frobnicator
 
     So very broken.
 
@@ -105,10 +153,6 @@ To resolve a bug::
 
     $ idli resolve 11 --message "Issue resolved by fixing the frobnicator."
 
-To assign a bug::
-
-    $ idli assign 11 scotty "I need warp drive now."
-
 Backends vary
 ~~~~~~~~~~~~~