Update readme with new options summary

guns · guns · commit 3bd91be0ef48 · 2013-01-08T19:53:50.000-06:00
diff --git a/README.markdown b/README.markdown
@@ -113,21 +113,63 @@ default values below:
 
 ### `g:clojure_maxlines`
 
-Maximum scan distance of searchpairpos().
+Maximum scan distance of searchpairpos(). Larger values trade performance
+for correctness when dealing with very long forms. A value of 0 means search
+without limits.
+```vim
+    " Default
+    let g:clojure_maxlines = 100
+```
+
+### `g:clojure_fuzzy_indent`, `g:clojure_fuzzy_indent_patterns`, and `g:clojure_fuzzy_indent_blacklist`
+
+The 'lispwords' option is a list of comma-separated words that mark special
+forms whose following lines must be indented as if the word is on the
+first line alone.
+
+For example:
+```vim
+    (defn good []
+      "Correct indentation")
+
+    (defn bad []
+          "Incorrect indentation")
+```
 
+If you would like to match words that match a pattern, you can use the
+fuzzy indent feature. The defaults are:
 ```vim
-" Default
-let g:clojure_maxlines = 100
+    " Default
+    let g:clojure_fuzzy_indent = 1
+    let g:clojure_fuzzy_indent_patterns = ['^with', '^def', '^let']
+    let g:clojure_fuzzy_indent_blacklist = ['^with-meta$', '-fn$']
+
+    " Legacy comma-delimited string version; the list format above is
+    " recommended. Note that patterns are implicitly anchored with ^ and $.
+    let g:clojure_fuzzy_indent_patterns = 'with.*,def.*,let.*'
 ```
 
-### `g:clojure_fuzzy_indent` and `g:clojure_fuzzy_indent_patterns`
+`g:clojure_fuzzy_indent_patterns` and `g:clojure_fuzzy_indent_blacklist` are
+*Lists* of patterns that will be matched against the unqualified symbol at the
+head of a list. This means that a pattern like `"^foo"` will match all these
+candidates: `"foobar"`, `"my.ns/foobar"`, and `"#'foobar"`.
 
-Indent words that match patterns as if they are included in `lispwords`.
+Each candidate word is tested for special treatment in this order:
 
+1. Return true if word is literally in 'lispwords'
+2. Return false if word matches a pattern in `g:clojure_fuzzy_indent_blacklist`
+3. Return true if word matches a pattern in `g:clojure_fuzzy_indent_patterns`
+4. Return false and indent normally otherwise
+
+### `g:clojure_special_indent_words`
+
+Some forms in Clojure are indented so that every subform is indented only two
+spaces, regardless of 'lispwords'. If you have a custom construct that should
+be indented in this idiosyncratic fashion, you can add your symbols to the
+default list below.
 ```vim
-" Default
-let g:clojure_fuzzy_indent = 1
-let g:clojure_fuzzy_indent_patterns = "with.*,def.*,let.*"
+    " Default
+    let g:clojure_special_indent_words = 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn'
 ```
 
 ### `g:clojure_align_multiline_strings`
@@ -136,24 +178,23 @@ When indenting multiline strings, align subsequent lines to the column
 after the opening quote, instead of the same column.
 
 For example:
-
 ```clojure
-(def default
-  "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
-  eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
-  enim ad minim veniam, quis nostrud exercitation ullamco laboris
-  nisi ut aliquip ex ea commodo consequat.")
-
-(def aligned
-  "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
-   eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
-   enim ad minim veniam, quis nostrud exercitation ullamco laboris
-   nisi ut aliquip ex ea commodo consequat.")
+    (def default
+      "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+      eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
+      enim ad minim veniam, quis nostrud exercitation ullamco laboris
+      nisi ut aliquip ex ea commodo consequat.")
+
+    (def aligned
+      "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+       eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
+       enim ad minim veniam, quis nostrud exercitation ullamco laboris
+       nisi ut aliquip ex ea commodo consequat.")
 ```
 
 ```vim
-" Default
-let g:clojure_align_multiline_strings = 0
+    " Default
+    let g:clojure_align_multiline_strings = 0
 ```
 
 License and Acknowledgements
