diff --git a/README.markdown b/README.markdown index c549a7b..8927fa9 100644 --- a/README.markdown +++ b/README.markdown @@ -1,5 +1,19 @@ vim-autoformat ============== -html, css, javascript by vim-jsbeautify -python by autopep8 +This vim plugin provides bindings for external code format programs. +If you have installed a supported formatter correctly, it will integrate with vim automatically. + +Supported programs: +* einars/jsbeautify for javascript (has to be installed as a pathogen-compatible plugin) +* autopep8 for python (must be globally available) + +How to install (Vundle) +----------------------- + +Put this in your .vimrc + +```vim +Bundle "Chiel92/vim-autoformat" +``` +