made better!

[sup] / README.txt

diff --git a/README.txt b/README.txt
index 95cb2fb15a872b5d4f3acf7172c3d8d96b56a4a0..ef985ccff7f4c4452b1d65b3cdd8ed1310c866a6 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -4,13 +4,30 @@ sup
 
 == DESCRIPTION:
 
-Sup is an attempt to take the UI innovations of web-based email
-readers (ok, really just GMail) and to combine them with the
-traditional wholesome goodness of a console-based email client.
+Sup is a console-based email client that combines the best
+features of GMail, mutt, and emacs. Sup matches the power of GMail
+with the speed and simplicity of a console interface.
 
-Sup is designed to work with massive amounts of email, potentially
-spread out across different mbox files, IMAP folders, and GMail
-accounts, and to pull them all together into a single interface.
+Sup makes it easy to:
+- Handle massive amounts of email.
+
+- Mix email from different sources: mbox files (even across
+  different machines), IMAP folders, POP accounts, and GMail
+  accounts.
+
+- Instantaneously search over your entire email collection. Search
+  over body text, or use a query language to combine search
+  predicates in any way.
+
+- Handle multiple accounts. Replying to email sent to a particular
+  account will use the correct SMTP server, signature, and from
+  address.
+
+- Add custom code to handle certain types of messages or to handle
+  certain types of text within messages.
+
+- Organize email with user-defined labels, automatically track
+  recent contacts, and much more!
 
 The goal of Sup is to become the email client of choice for nerds
 everywhere.
@@ -53,8 +70,8 @@ Features:
 
 Current limitations which will be fixed:
 
-- Support for mbox only at this point. No support for POP, IMAP, mh,
-  GMail mailstores.
+- Support for mbox and IMAP only at this point. No support for POP, mh,
+  or GMail mailstores.
 
 - No internationalization support. No wide characters, no subject
   demangling. 
@@ -67,10 +84,15 @@ Current limitations which will be fixed:
 
 == SYNOPSYS:
 
-  1. sup-import <mbox filename>+
+  1. sup-import <source>+
   2. sup
   3. edit ~/.sup/config.yaml for the (very few) settings sup has
 
+  Where <source> is a filename (for mbox files), or an imap or imaps
+  url. In the case of imap, don't put the username and password in
+  the URI (which is a terrible, terrible idea). You will be prompted
+  for them.
+
   sup-import has several options which control whether you want
   messages from particular mailboxes not to be added to the inbox,
   or not to be marked as new, so run it with -h for help.
@@ -93,7 +115,7 @@ Current limitations which will be fixed:
 * gem install sup -y
 * Then, in rmail, change line 159 of multipart.rb to:
     chunk = chunk[0..start]
-  (Sorry. it's an unsupported package.) You might be able to get away
+  (Sorry; it's an unsupported package.) You might be able to get away
   without doing this but if you get frozen string exceptions when
   reading in multipart messages, this is what you need to change.