From b0a5513065245a12d9e8875532363793a052ec98 Mon Sep 17 00:00:00 2001 From: Nate Kane Date: Sun, 12 Dec 2010 00:14:56 +1000 Subject: [PATCH] Updated the readme --- README.markdown | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.markdown b/README.markdown index 897ad56..de09c11 100644 --- a/README.markdown +++ b/README.markdown @@ -1,14 +1,18 @@ # Indent Guides -A Vim plugin for visually displaying indent levels. +Indent Guides is a plugin for visually displaying indent levels in vim. -**Status:** almost ready for an official release. +## Features: +* Can detect both tab and space indent styles. +* Automatically inspects your colorscheme and picks appropriate colors. +* Will highlight indent levels with alternating colors. ## Installation -Coming soon. +To install the plugin just copy `autoload`, `plugin`, `doc` directories into your .vim directory. -## Features -* Can handle both tab and space indent styles -* Automatically inspects your vim colorscheme and picks appropriate colors +Alternatively if you have [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) installed, just clone this repo into a subdirectory of your .vim/bundle directory like so: + + cd ~/.vim/bundle + git clone git://github.com/nathanaelkane/vim-indent-guides.git ## Usage The default mapping to toggle the plugin is `ig` @@ -16,6 +20,9 @@ The default mapping to toggle the plugin is `ig` ## Help `:help indent-guides` -## Screenshot -Indent Guides - Screenshot +## Screenshots +Indent Guides screenshot: rdark +Indent Guides screenshot: bclear +Indent Guides screenshot: clarity +Indent Guides screenshot: moss