X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=README;h=14a35ae8449ea591a056eb8fba35ac62f1622b8b;hp=3b96e6483aed59c02eb2bdc4eafabc8bea2c3068;hb=65061756489566f134b6aeec7ef51cb6164be088;hpb=b4fdf0ae30e0847a759c01524898d0b9d803c43b

diff --git a/README b/README
index 3b96e648..14a35ae8 100644
--- a/README
+++ b/README
@@ -1,9 +1,33 @@
+cnotmuch -- The python interface to notmuch.so
+==============================================
+To create the documentation with sphinx installed, go to the docs directory and
+"make html". A static version of the documentation is available at:
+
+http://spaetz.bitbucket.org
+
+All code is available under the GNU GPLv3+ (see docs/COPYING) unless specified otherwise.
+
+Usage
+-----
+For more examples of how to use the cnotmuch interface, have a look at the
+notmuch "binary" and the generated documentation.
+
+Example session:
 >>>from cnotmuch import notmuch
 >>>db = notmuch.Database("/home/spaetz/mail")
->>>db.get_path()
+db.get_path()
+'/home/spaetz/mail'
 >>>tags = db.get_all_tags()
 >>>for tag in tags: 
 >>>  print tag
+inbox
+...
+maildir::draft
+#---------------------------------------------
+
+q = notmuch.Query(db,'from:Sebastian')
+count = len(q.search_messages())
+1300
 
 #---------------------------------------------
 
@@ -14,5 +38,3 @@ NotmuchError: Could not open the specified database
 
 >>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
 >>>del(tags)
-Freeing the Tags now
-Freeing the database now
\ No newline at end of file