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

diff --git a/README b/README
index 14a35ae8..5f029c82 100644
--- a/README
+++ b/README
@@ -1,40 +1,71 @@
-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()
->>>for tag in tags: 
->>>  print tag
-inbox
-...
-maildir::draft
-#---------------------------------------------
-
-q = notmuch.Query(db,'from:Sebastian')
-count = len(q.search_messages())
-1300
-
-#---------------------------------------------
-
->>>db = notmuch.Database("/home/spaetz/mailHAHA")
-NotmuchError: Could not open the specified database
-
-#---------------------------------------------
-
->>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
->>>del(tags)
+Notmuch - thread-based email index, search and tagging.
+
+Notmuch is a system for indexing, searching, reading, and tagging
+large collections of email messages in maildir or mh format. It uses
+the Xapian library to provide fast, full-text search with a convenient
+search syntax.
+
+Notmuch is free software, released under the GNU General Public
+License version 3 (or later).
+
+Building notmuch
+----------------
+See the INSTALL file for notes on compiling and installing notmuch.
+
+Contacting users and developers
+-------------------------------
+The website for Notmuch is:
+
+	http://notmuchmail.org
+
+The mailing list address for the notmuch community is:
+
+	notmuch@notmuchmail.org
+
+We welcome any sort of questions, comments, kudos, or code there.
+
+Subscription is not required, (but if you do subscribe you'll avoid
+any delay due to moderation). See the website for subscription
+information.
+
+There is also an IRC channel dedicated to talk about using and
+developing notmuch:
+
+	IRC server:	irc.freenode.net
+	Channel:	#notmuch
+
+Interface options
+-----------------
+Notmuch includes a "notmuch" command-line interface to the system.
+This is not a very convenient interface and it is not expected that
+users will find it satisfying. Instead, there are two option for
+obtaining a more sophisticated interface:
+
+     1. Build on top of the "notmuch" command-line interface.
+
+	This might be a reasonable option for a very text-oriented
+	client environment. For example, an emacs-based interface for
+	notmuch is already under development and is available in the
+	notmuch.el file in this distribution.
+
+	If someone were to write a curses-based interface, or similar,
+	it might also be reasonable to build on the "notmuch"
+	command-line interface.
+
+     2. Build on top of the notmuch library interface.
+
+	This is a better choice for developing an interface that has
+	full control of the presentation of email threads and
+	messages. It is expected that anyone integrating Notmuch into
+	an existing, graphical email program use the notmuch library
+	interface.
+
+	The public interface to the notmuch library is contained in
+	the notmuch.h header file. The "notmuch" command-line program
+	in notmuch.c can be used as good example code, since it is a
+	simple program that is written on top of the library
+	interface.
+
+As can be seen, alternate interfaces to the Notmuch mail system are
+still in development. We would appreciate any contributions to these
+efforts.