added mappings list to readme

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 2aa9dcab2f16a9485909d61347de5f36aa2e3573..871ed6594766afd4cfe0508b417f907d82842693 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Markdown Vim Mode
 
-Syntax highlighting and matching rules for [Markdown](http://daringfireball.net/projects/markdown/).
+Syntax highlighting, matching rules and mappings for [Markdown](http://daringfireball.net/projects/markdown/).
 
 ## Installation
 
@@ -12,10 +12,28 @@ If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and
 To install without Pathogen, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 
     $ cd ~/.vim
-    $ tar -zxf vim-markdown-master.tgz
+    $ tar --strip=1 -zxf vim-markdown-master.tar.gz
 
 [Homepage](http://plasticboy.com/markdown-vim-mode/)
 
+## Options
+
+**Disable Folding**
+
+Add the following line to your `.vimrc` to disable folding.
+
+```vim
+let g:vim_markdown_folding_disabled=1
+```
+
+## Mappings
+
+- `nn ]]`: go to next header
+- `nn ][`: go to next sibling header if any
+- `nn ]u`: go to parent header (Up)
+- `nn [[`: go to previous header
+- `nn []`: go to previous sibling header if any
+
 ## License
 
 The MIT License (MIT)