From 9c2138bc5e4c9eb963f4c43ac6391de022e24baa Mon Sep 17 00:00:00 2001
From: lyuts <dioxinu@gmail.com>
Date: Fri, 18 Jul 2014 21:00:44 -0700
Subject: [PATCH] Updated readme.

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7aaa4d74..48d642b0 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,52 @@ Vim bindings for rtags.
 https://github.com/Andersbakken/rtags
 
 # Requirements
-1. Vim built with +python.
+1. Vim built with ```+python```.
+
+# Installation
+## Vundle
+Add the following line to ```.vimrc```
+
+    Plugin 'lyuts/vim-rtags'
+
+then while in vim run:
+
+    :source %
+    :PluginInstall
+
+## NeoBundle
+Add the following line to ```.vimrc```
+
+    NeoBundle 'lyuts/vim-rtags'
+
+then while in vim run:
+
+    :source %
+    :NeoBundleInstall
+
+## Pathogen
+    $ cd ~/.vim/bundle
+    $ git clone https://github.com/lyuts/vim-rtags
+
+# Configuration
+This plugin interacts with RTags by invoking ```rc``` commands and interpreting
+their results.  You can override the path to ```rc``` binary by setting
+```g:rcCmd``` variable.  By default, it is set to ```rc```, expecting it to be
+found in the $PATH.
+
+Out of box this plugin provides mappings. In order to use custom mappings the
+default mappings can be disabled:
+
+    let g:rtagsUseDefaultMappings = 0
+
+# Usage
 
 # Notes
 1. This plugin is wip.
+1. Code completion with rtags is not done yet.
+
+# Development
+Unit tests for some plugin functions can be found in ```tests``` directory.
+To run tests, execute:
+
+    $ vim tests/test_rtags.vim +UnitTest