Add Toc commands.

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 41f606f73d35da69a14a10cad038b4d71ca2d448..843405f0035e32819a0656151ae0746e58406191 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,13 +18,18 @@ If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:
     $ cd ~/.vim/bundle
     $ git clone https://github.com/plasticboy/vim-markdown.git
 
+To install without Pathogen using the Debian [vim-addon-manager](http://packages.qa.debian.org/v/vim-addon-manager.html), do this:
+
+    $ git clone https://github.com/plasticboy/vim-markdown.git
+    $ cd vim-markdown
+    $ sudo make install
+    $ vim-addon-manager install mkd
+
 If you are not using any package manager, download the [tarball](https://github.com/plasticboy/vim-markdown/archive/master.tar.gz) and do this:
 
     $ cd ~/.vim
     $ tar --strip=1 -zxf vim-markdown-master.tar.gz
 
-[Homepage](http://plasticboy.com/markdown-vim-mode/)
-
 ## Options
 
 **Disable Folding**
@@ -54,6 +59,26 @@ The following work on normal and visual modes:
 - `]c`: go to Current header.
 - `]u`: go to parent header (Up).
 
+## Commands
+
+The following commands currently only work for atx style headers (`#`). Pull request are welcome to extend them to Setext style headers (`===`).
+
+- `:Toc`: create a quickfix vertical window navigable table of contents with the headers.
+
+    Hit `<Enter>` on a line to jump to the corresponding line of the markdown file.
+
+- `:Toch`: Same as `:Toc` but in an horizontal window.
+- `:Toct`: Same as `:Toc` but in a new tab.
+- `:Tocv`: Same as `:Toc` for symmetry with `:Toch` and `Tocv`.
+
+## Credits
+
+The main contributors of vim-markdown are:
+
+- **Ben Williams** (A.K.A. **plasticboy**). 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)