diff --git a/README.mkd b/README.mkd index ce6103a..587f633 100644 --- a/README.mkd +++ b/README.mkd @@ -54,9 +54,11 @@ Add `Plugin 'airblade/vim-gitgutter'` to your `~/.vimrc` and then: If you are on Windows you may find the command prompt pops up briefly every time vim-gitgutter runs. You can avoid this by installing both [vim-misc](https://github.com/xolox/vim-misc) and [vim-shell](https://github.com/xolox/vim-shell). If you have those two plugins but don't want vim-gitgutter to use them, you can opt out with `let g:gitgutter_avoid_cmd_prompt_on_windows = 0` in your `~/.vimrc`. -### Usage +### Getting started -You don't have to do anything: it just works. +When you make a change to a file tracked by git, the diff markers should appear automatically. The delay is governed by vim's `updatetime` option; the default value is 4 seconds but I suggest reducing it to around 250ms (add `set updatetime=250` to your vimrc). + +You can jump between hunks with `[c` and `]c`. You can preview, stage, and revert hunks with `hp`, `hs`, and `hr` respectively. #### Activation