Merge pull request #32 from mutewinter/folding_option

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index c47f7d234f03feface10242db76bb113df5da955..2d7e587ea9f8550bf6c6a73e2ec8d9af027169e5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,39 @@
+# Markdown Vim Mode
 
+Syntax highlighting and matching rules for [Markdown](http://daringfireball.net/projects/markdown/).
 
+## Installation
 
-#Markdown Vim Mode
-Syntax highlighting and matching rules for markdown See the [origional webpost for full details](http://plasticboy.com/markdown-vim-mode/)
+If you use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)(and you should), do this:
 
+    $ cd ~/.vim/bundle
+    $ git clone https://github.com/plasticboy/vim-markdown.git
+
+To install without Pathogen, 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**
+
+Add the following line to your `.vimrc` to disable folding.
+
+```vim
+let g:vim_markdown_folding_disabled=1
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2012 Benjamin D. Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.