README.md in vimwiki_markdown-0.0.2 vs README.md in vimwiki_markdown-0.0.3

@@ -3,26 +3,55 @@
 This gem allows vimwiki pages written in (github enhanced) markdown
 to be converted to HTML.
 
 It is currently a work in progress (but working for me ;)
 
-## Installation
+## Requirements
 
-Add this line to your application's Gemfile:
+Ruby installed on your computer
 
-    gem 'vimwiki_markdown'
+    https://www.ruby-lang.org/en/installation/
 
-And then execute:
+Install the vimwiki_markdown gem
 
-    $ bundle
+    $ gem install vimwiki_markdown
 
-Or install it yourself as:
+Note, the current version of vimwiki does not allow binaries to be called
+for the generation of html.  This was added on the master branch in [this commit](https://github.com/vimwiki/vimwiki/commit/c1a5bb51adc8cacaa70e2804106817b68295f932)
 
-    $ gem install vimwiki_markdown
+Currently you will need to make sure you are running the dev branch of vimwiki, or add that commit in yourself
 
+## Setup
+
+Ensure that your vimiwiki directive in your .vimrc is setup for markdown.  For
+this we use the custom_wiki2html parameter.  My .vimrc looks like this:
+
+    let g:vimwiki_list = [{'path': '~/vimwiki', 'template_path': '~/vimwiki/templates/',
+              \ 'template_default': 'default', 'syntax': 'markdown', 'ext': '.md',
+              \ 'path_html': '~/vimwiki/site_html/', 'custom_wiki2html': 'vimwiki_markdown',
+              \ 'template_ext': '.tpl'}]
+
+The most important part is the *'custom_wiki2html': 'vimwiki_markdown'*
+
+### VimWiki Template
+
+It is a requirement that your template file contain a placeholder
+for the syntax highlighting code to be placed.  In order to do this,
+open up your default.tpl (or whatever your template file is called)
+and ensure that before the closing </head> tag you put
+`%pygments%`
+
+A sample tpl file is available here https://raw.githubusercontent.com/patrickdavey/vimwiki_markdown/master/example_files/default.tpl
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/patrickdavey/vimwiki_markdown/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+## License
+
+[MIT License](http://opensource.org/licenses/mit-license.php)