From: Bart Trojanowski <bart@jukie.net>
Date: Thu, 19 Nov 2009 02:18:24 +0000 (-0500)
Subject: updated README
X-Git-Tag: 0.1~313^2~101
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=3fe89c43dd484cc90efabc12055c9dda5383d009;p=notmuch.git

updated README
---

diff --git a/vim/README b/vim/README
index bd453a40..c55875b1 100644
--- a/vim/README
+++ b/vim/README
@@ -1,10 +1,28 @@
 This directory contains a vim script that allows reading notmuch mail
 through vim.
 
-To install:
+NOTE: this is a work in progress.  Patches welcome. <bart@jukie.net>
 
+To install:
         make install
 
 To run:
-
         vim -c ':NotMuch'
+
+    from vim:
+        :NotMuch
+
+Buffer types:
+    [notmuch-search]
+        You are presented with the search results when you run :NotMuch.
+
+        Keybindings:
+            <Enter> - show the selected message
+            s       - alter search criteria
+
+    [notmuch-show]
+        This is the display of the message.
+
+        Keybindings:
+            q       - return to search display
+