diff --git a/README.md b/README.md index f73e195..6a27902 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ +# vim-vue + Vim syntax highlighting for [Vue components](http://vuejs.org/guide/application.html#Single_File_Components). + +## Installation + +### Install with (Vundle)[] + +Add this line to your vimrc: + +`Plugin 'darthmall/vim-vue'` + +Then reload your vim configuration and run `PluginInstall`: + +```vim +:source ~/.vimrc +:PluginInstall +``` + +### Manual Installation + +```bash +$ git clone https://github.com/darthmall/vim-vue.git +$ cp vim-vue/ftdetect/vue.vim ~/.vim/ftdetect/ +$ cp vim-vue/syntax/vue.vim ~/.vim/syntax +``` + +[Vundle]: https://github.com/gmarik/Vundle.vim