created a credits section, removed link to the old homepage since it is too outdated

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 2d7e587ea9f8550bf6c6a73e2ec8d9af027169e5..95db711078a6f92831e650a06b3334d57b74c53a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Markdown Vim Mode
 
 # 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
 
 
 ## Installation
 


@@ -14,8 +14,6 @@ To install without Pathogen, download the [tarball](https://github.com/plasticbo
     $ cd ~/.vim
     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
 
     $ cd ~/.vim
     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
 

-[Homepage](http://plasticboy.com/markdown-vim-mode/)
-

 ## Options
 
 **Disable Folding**
 ## Options
 
 **Disable Folding**


@@ -26,6 +24,35 @@ Add the following line to your `.vimrc` to disable folding.
 let g:vim_markdown_folding_disabled=1
 ```
 
 let g:vim_markdown_folding_disabled=1
 ```
 

+**Set Initial Foldlevel**
+
+Add the following line to your `.vimrc` to set the initial foldlevel.  This
+option defaults to 0 (i.e. all folds are closed) and is ignored if folding
+is disabled.
+
+```vim
+let g:vim_markdown_initial_foldlevel=1
+```
+
+## Mappings
+
+The following work on normal and visual modes:
+
+- `]]`: go to next header.
+- `[[`: go to previous header. Contrast with `]c`.
+- `][`: go to next sibling header if any.
+- `[]`: go to previous sibling header if any.
+- `]c`: go to Current header.
+- `]u`: go to parent header (Up).
+
+## Credits
+
+The main contributors of vim-markdown are:
+
+- **Ben Williams** (A.K.A. **platicboy**). The original developer of vim-markdown. [Homepage](http://plasticboy.com/).
+
+If you feel that your name should be on this list, please make a pull request listing your contributions.
+

 ## License
 
 The MIT License (MIT)
 ## License
 
 The MIT License (MIT)