added vim readme

README.rst

@@ -0,0 +1,72 @@
+#################################################
+jedi-vim - awesome Python autocompletion with VIM
+#################################################
+
+**now in beta testing phase**
+
+*If you have any comments or feature request, please tell me! I really want to
+know, what you think about Jedi and jedi-vim.*
+
+jedi-vim is a is a VIM binding to the awesome autocompletion library *Jedi*.
+
+Get the latest from `github <http://github.com/davidhalter/jedi-vim>`_.
+
+You can get the Jedi library from
+`github <http://github.com/davidhalter/jedi>`_.
+
+
+Support
+=======
+
+The Jedi library supports most of Python's core features. From decorators to
+generators, there is broad support.
+
+
+Installation
+============
+
+You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ to
+install jedi in VIM. Also you need a VIM version that was compiled with
+``+python``, which is typical for most distributions on Linux.
+
+The autocompletion can be used with <ctrl+space>, if you want it to work with
+<tab> you can use `supertab <https://github.com/ervandew/supertab>`_.
+
+
+Options
+=======
+
+Jedi is by default automatically initialized. If you don't want that I suggest
+you disable the auto-initialization in your ``.vimrc``::
+
+    let g:jedi#auto_initialization = 0
+
+The goto is by default on <leader g>. If you want to change that::
+
+    let g:jedi#goto_command = "<leader>g"
+
+``get_definition`` is by default on <leader d>. If you want to change that::
+
+    let g:jedi#get_definition_command = "<leader>d"
+
+Showing the pydoc is by default on ``K`` If you want to change that::
+
+    let g:jedi#pydoc = "K"
+
+If you are a person who likes to use VIM-buffers not tabs, you might want to
+put that in your ``.vimrc``::
+
+    let g:jedi#use_tabs_not_buffers = 0
+
+Jedi automatically starts the completion, if you type a dot, e.g. ``str.``, if
+you don't want this::
+
+    let g:jedi#popup_on_dot = 0
+
+There's some support for refactoring::
+
+    let g:jedi#rename_command = "<leader>r"
+
+And you can list all names that are related (have the same origin)::
+
+    let g:jedi#related_names_command = "<leader>n"