Add docs

frenchy64 · frenchy64 · commit af2757004a76 · 2014-02-10T00:03:31.000+08:00
diff --git a/doc/typedclojure.txt b/doc/typedclojure.txt
@@ -0,0 +1,38 @@
+*typedclojure.txt*  A plugin for Typed Clojure
+
+Author:  Ambrose Bonnaire-Sergeant <abonnairesergeant@gmail.com>
+License: Same terms as Vim itself (see |license|)
+
+Requires |fireplace| <https://github.com/tpope/vim-fireplace>.
+
+INTRODUCTION                                    *typedclojure*
+
+Whenever you edit a Clojure file, bindings related to Typed Clojure are added
+alongside those defined via |fireplace|.
+
+COMMANDS                                        *typedclojure-commands*
+
+These commands are local to buffers editing Clojure files.
+
+                                                *typedclojure-:CheckNs*
+:CheckNs                Type check the current namespace.  Any type errors 
+                        are loaded into a quickfix list which is opened 
+                        automatically. These mappings are valid inside the 
+                        quickfix window, operating on the current line:
+
+                        ce  show the type error message in a preview window
+
+MAPPINGS                                        *typedclojure-mappings*
+
+These maps are available in Clojure buffers alongside |fireplace|.
+
+                                                *typedclojure-ctn*
+ctn                     Type check the current namespace.
+
+ABOUT                                           *typedclojure-about*
+
+Please report issues on Github:
+
+https://github.com/typedclojure/vim-typedclojure
+
+ vim:tw=78:et:ft=help:norl:
