From 06b6ef822c787af3204c61c901e4e5daa27233d8 Mon Sep 17 00:00:00 2001 From: lepture Date: Thu, 13 Sep 2012 18:05:55 +0800 Subject: [PATCH] update readme --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c803863..c2cae5f 100644 --- a/README.md +++ b/README.md @@ -1 +1,49 @@ -# vim plugins for Jinja +# Jinja for Vim + +Jinja bundle for vim. + + +## Feature + +1. full syntax support +2. great indent support + +## Installation + +- Install with [Vundle](https://github.com/gmarik/vundle) + +If you are not using vundle, you really should have a try. +Edit your vimrc: + + Bundle "lepture/vim-jinja" + +And install it: + + :so ~/.vimrc + :BundleInstall + + +- Install with [pathogen](https://github.com/tpope/vim-pathogen) + +If you prefer tpope's pathogen, that's ok. Just clone it: + + cd ~/.vim/bundle + git clone https://github.com/lepture/vim-jinja.git + + +## Configuration + +No configuration is needed, if you are using vim 7.2+, it will detect if +a html file is a jinja template. + +But if you want to ensure it works well, you can edit your vimrc: + +```vim +au BufNewFile,BufRead *.html,*.htm,*.shtml,*.stm set ft=jinja +``` + + +## Bug report + +Report a bug on [GitHub Issues](https://github.com/lepture/vim-jinja/issues). +