Add CONTRIBUTING.md and AUTHORS.rst

[etc/vim.git] / README.rst

diff --git a/README.rst b/README.rst
index 771c4cb09900d5c0883a2b5e69b1df19f1fa080a..2ca7ef9f6087e58e888c1885d2f18010a4ddb84c 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,9 @@
 vim-python-pep8-indent
 ======================
 
+.. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis
+   :target: https://travis-ci.org/hynek/vim-python-pep8-indent
+
 This small script modifies vim_’s indentation behavior to comply with PEP8_ and
 my aesthetic preferences: ::
 
@@ -38,6 +41,12 @@ The easiest way is to use pathogen_ and do a ::
 
 in your `~/.vim/bundle`. And you *should* use pathogen. Really.
 
+Please note that Kirill Klenov’s python-mode_ ships an own version of of this
+bundle.  Therefore, if you want to use this version specifically, you’ll have
+to disable python-mode’s using: ::
+
+   let g:pymode_indent = 0
+
 .. _vim: http://www.vim.org/
 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
@@ -45,3 +54,4 @@ in your `~/.vim/bundle`. And you *should* use pathogen. Really.
 .. _here: https://gist.github.com/2965846
 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
 .. _pathogen: https://github.com/tpope/vim-pathogen
+.. _python-mode: https://github.com/klen/python-mode