]> git.notmuchmail.org Git - notmuch/blobdiff - README
python: Adapt README somewhat
[notmuch] / README
diff --git a/README b/README
index d7107b7d3ea008abf2806fcdcaa38ff479cd7711..cdf9d7ae0aa7dea63b6e100a0a4d514e6c1335fc 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-cnotmuch -- The python interface to notmuch.so
+notmuch -- The python interface to notmuch.so
 ==============================================
 
 This module makes the functionality of the notmuch library
@@ -6,13 +6,11 @@ This module makes the functionality of the notmuch library
 this modul depends on a libnotmuch.so|dll being available on the
 user's system.
 
-If you have downloaded the full source tarball (available from
-bitbucket.org, the source distribution and binary distribution come
-without the documentation), you can create the documentation with
-sphinx installed, go to the docs directory and "make html". A static
-version of the documentation is available at:
+If you have downloaded the full source tarball, you can 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`_
+http://packages.python.org/cnotmuch/
 
 The current source code is being hosted at
 http://bitbucket.org/spaetz/cnotmuch which also provides an issue
@@ -47,7 +45,7 @@ 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
+>>>import notmuch
 >>>db = notmuch.Database("/home/spaetz/mail")
 db.get_path()
 '/home/spaetz/mail'
@@ -72,3 +70,18 @@ NotmuchError: Could not open the specified database
 
 >>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
 >>>del(tags)
+
+
+Building for a Debian package
+------------------------------
+dpkg-buildpackage -i"\.hg|\/build"
+
+
+Changelog
+---------
+0.1   First public release
+0.1.1 Fixed Database.create_query()
+0.2.0 Implemented Thread() and Threads() methods
+0.2.1 Implemented the remaining API methods, notably Directory() and Filenames()
+0.2.2 Bug fixes
+0.3.0 Incorporated in the notmuchmail.org git repository
\ No newline at end of file