From: Sebastian Spaeth <sebastian@sspaeth.de>
Date: Wed, 17 Mar 2010 08:28:39 +0000 (+0100)
Subject: README: add link to static docs
X-Git-Tag: 0.3~121^2~81
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=65061756489566f134b6aeec7ef51cb6164be088;p=notmuch.git

README: add link to static docs
---

diff --git a/README b/README
index 3fbdab1b..14a35ae8 100644
--- a/README
+++ b/README
@@ -1,15 +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()
 '/home/spaetz/mail'
 >>>tags = db.get_all_tags()
-inited tags with 44762960 'Notmuch DB /home/spaetz/mail'
 >>>for tag in tags: 
 >>>  print tag
 inbox
 ...
 maildir::draft
-Freeing the Tags now
+#---------------------------------------------
+
+q = notmuch.Query(db,'from:Sebastian')
+count = len(q.search_messages())
+1300
 
 #---------------------------------------------
 
@@ -20,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