added some documentation

diff --git a/README.notmuch b/README.notmuch
index f2624fca567eec79b7cc4bbeb76c029b2a100757..d0e68b0c89a6e2a21f60f126fcd9d44cb96db9a2 100644 (file)
--- a/README.notmuch
+++ b/README.notmuch
@@ -155,6 +155,29 @@ notmuch support for mutt
                      "sent"    "➥ "  \
                      "todo"    "T"   \
                      "deleted" "DEL" \
+                     "invites" "CAL"
+
+   tag-formats <tag> <format sequence> [ ...]
+
+      Specify index formatting sequences for individual tags for direct
+      placement in the $index_format. The formats must start with 'G' and
+      the entire sequence is case sensitive.
+
+      example:
+
+      tag-formats "inbox"   "GI" \
+                  "unread"  "GU" \
+                  "replied" "GR" \
+                  "sent"    "GS" \
+                  "todo"    "Gt" \
+                  "deleted" "GD" \
+                  "invites" "Gi"
+
+      Now instead of using '%g' in your $index_format, which lists all tags
+      in a non-deterministic order, you can something like the following which puts
+      a transformed tag name in a specific spot on the index line:
+
+      set index_format='4C %S %[%y.%m.%d] %-18.18n %?GU?%GU& ? %?GR?%GR& ? %?GI?%GI& ? %s'
 
    nm_record = <boolean>