Merge branch 'help-documentation'

.gitignore

@@ -1 +1,2 @@
+doc/tags
 build

README

@@ -14,7 +14,7 @@ git clone https://github.com/vitalk/vim-simple-todo
 USAGE
 
 All this mappings use the <leader> key and they work the same on NORMAL and
-INSERT modes. I prefer to use the coma as the <leader> key but fell free to set
+INSERT modes. I prefer to use the comma as the <leader> key but fell free to set
 your own.
 
 ,i      create new todo under cursor
@@ -23,6 +23,18 @@ your own.
 ,x      mark todo under cursor as done
 ,X      mark todo as undone
 
+Or even remap them to somethings more comfortable for you:
+
+# Disable default key bindings
+let g:simple_todo_map_keys = 0
+
+# Map your keys
+nmap <c-i> <Plug>(simple-todo-new)
+imap <c-i> <Plug>(simple-todo-new)
+# ...etc.
+
+See ':help simple-todo-maps' for list of available <Plug> mappings.
+
 TODO
 
 [x] publish to github

doc/simple-todo.txt

@@ -0,0 +1,64 @@
+*simple-todo.txt*   Manage todo lists. Really simple.
+
+Author:     Vital Kudzelka | <[email protected]>
+License:    MIT | http://mit-license.org/vitalk
+
+
+                              Reference manual~
+
+==============================================================================
+Manage todo lists. Really simple.                                *simple-todo*
+
+    1. Intro.................................|simple-todo-into|
+    2. Mappings..............................|simple-todo-maps|
+    3. Contributing..........................|simple-todo-contrib|
+
+==============================================================================
+1. Intro                                                    *simple-todo-into*
+
+Plugin provides handy mappings to manage simple todo lists.
+
+Supported format of todo list is similar to task lists used in GitHub Flavored
+Markdown. Read GitHub blog article for example:
+
+https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments
+
+
+==============================================================================
+2. Mappings                                                 *simple-todo-maps*
+
+Plugin exposes some <Plug> maps. These maps are available for normal and
+insert modes.
+
+To completely disable default key bindings (which is pretty handy) use:
+>
+let g:simple_todo_map_keys = 0
+<
+                                                     *<Plug>(simple-todo-new)*
+<Plug>(simple-todo-new)
+<leader>i                   Create a new item
+
+                                                   *<Plug>(simple-todo-below)*
+<Plug>(simple-todo-below)
+<leader>o                   Create a new item below
+
+                                                   *<Plug>(simple-todo-above)*
+<Plug>(simple-todo-above)
+<leader>O                   Create a new item above
+
+                                            *<Plug>(simple-todo-mark-as-done)*
+<Plug>(simple-todo-mark-as-done)
+<leader>x                   Mark item under cursor as done.
+
+                                          *<Plug>(simple-todo-mark-as-undone)*
+<Plug>(simple-todo-mark-as-undone)
+<leader>X                   Mark item under cursor as undone
+
+==============================================================================
+3. Contributing                                          *simple-todo-contrib*
+
+Don't hesitate to create a new GitHub Issue for any bug or suggestion:
+
+https://github.com/vitalk/vim-simple-todo/issues
+
+vim:tw=78:et:ft=help:norl: