vim-signify/README.md

![vim-signify](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-logo.png)

[![Join the chat at https://gitter.im/mhinz/mhinz](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mhinz/mhinz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mhinz/vim-signify/master/LICENSE)

---

Signify (or just Sy) is a quite unobtrusive plugin. It uses signs to indicate
added, modified and removed lines based on data of an underlying version
control system.

It's __fast__, __easy to use__ and __well documented__.

_NOTE:_ If git is the only version control system you use, I suggest having a
look at [vim-gitgutter](https://github.com/airblade/vim-gitgutter). It provides
more git-specific features that would be unfeasible for Sy, since it only
implements features that work for _all_ supported VCS.

**Features:**

- supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev,
  perforce
- quick jumping between blocks of changed lines ("hunks")
- apart from signs there is also optional line highlighting
- preserves signs from other plugins
- you can toggle the plugin per buffer
- good documentation
- skip certain filetypes and filenames
- depending on your usual workflow you can disable it per default and enable on
  demand later
- fully configurable through global variables (options and mappings)

## Installation and Documentation

Use your favorite plugin manager.

Using [vim-plug](https://github.com/junegunn/vim-plug):

    Plug 'mhinz/vim-signify'

It works without any configuration, but you might want to look into the
documentation for further customization:

    :h signify

_NOTE_: The single most important option by far is `g:signify_vcs_list`. Please
read `:h g:signify_vcs_list`.

## Demo

![Example:signify in action](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-demo.gif)

## Author and Feedback

If you like my plugins, please star them on Github. It's a great way of getting
feedback. Same goes for issues reports or feature requests.

Contact:
[Mail](mailto:mh.codebro@gmail.com) |
[Twitter](https://twitter.com/_mhinz_) |
[Gitter](https://gitter.im/mhinz/mhinz)

Co-maintainer: [@jamessan](https://github.com/jamessan)

_Get your Vim on!_
README: complete revamp 2015-12-27 17:09:26 -05:00			`![vim-signify](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-logo.png)`
add README 2013-03-05 14:07:37 -05:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`[![Join the chat at https://gitter.im/mhinz/mhinz](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mhinz/mhinz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
			`[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mhinz/vim-signify/master/LICENSE)`
README: refactoring 2013-10-02 08:27:22 -04:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`---`
README: refactoring 2013-10-02 08:27:22 -04:00
			`Signify (or just Sy) is a quite unobtrusive plugin. It uses signs to indicate`
			`added, modified and removed lines based on data of an underlying version`
			`control system.`
use "sy" as short name for signify 2013-03-06 17:40:57 -05:00
README: refactoring 2013-10-02 08:27:22 -04:00			`It's __fast__, __easy to use__ and __well documented__.`
add screenshot 2013-03-05 18:30:30 -05:00
README: update References #113. 2014-12-11 11:28:14 -05:00			`_NOTE:_ If git is the only version control system you use, I suggest having a`
			`look at [vim-gitgutter](https://github.com/airblade/vim-gitgutter). It provides`
			`more git-specific features that would be unfeasible for Sy, since it only`
			`implements features that work for _all_ supported VCS.`

README: complete revamp 2015-12-27 17:09:26 -05:00			`Features:`
add README 2013-03-05 14:07:37 -05:00
Docs: add perforce 2013-07-29 19:27:05 -04:00			`- supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev,`
			`perforce`
README: update 2014-10-04 10:20:17 -04:00			`- quick jumping between blocks of changed lines ("hunks")`
improve README 2013-03-05 14:12:24 -05:00			`- apart from signs there is also optional line highlighting`
README: update 2014-10-04 10:20:17 -04:00			`- preserves signs from other plugins`
add sign preserving option 2013-03-07 06:56:25 -05:00			`- you can toggle the plugin per buffer`
add README 2013-03-05 14:07:37 -05:00			`- good documentation`
README: update 2014-10-04 10:20:17 -04:00			`- skip certain filetypes and filenames`
README: refactoring 2013-10-02 08:27:22 -04:00			`- depending on your usual workflow you can disable it per default and enable on`
			`demand later`
README: update 2014-10-04 10:20:17 -04:00			`- fully configurable through global variables (options and mappings)`
add README 2013-03-05 14:07:37 -05:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`## Installation and Documentation`
new option: g:signify_line_highlight You can enable line highlighting per default now. 2013-04-04 05:14:07 -04:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`Use your favorite plugin manager.`
add options to README 2013-03-07 07:55:18 -05:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`Using [vim-plug](https://github.com/junegunn/vim-plug):`

			`Plug 'mhinz/vim-signify'`
update signs on CursorHold or CursorHoldI I added 2 new options that are disabled by default. Sign updating can now be triggered after 'updatetime' miliseconds without keypresses in either normal or insert mode: For enabling: let g:signify_cursorhold_normal = 1 let g:signify_cursorhold_insert = 1 2013-03-12 07:25:22 -04:00
README: refactoring 2013-10-02 08:27:22 -04:00			`It works without any configuration, but you might want to look into the`
			`documentation for further customization:`
add README 2013-03-05 14:07:37 -05:00
README: refactoring 2013-10-02 08:27:22 -04:00			`:h signify`
add README 2013-03-05 14:07:37 -05:00
README: stress importance of the vcs list 2013-12-01 06:04:58 -05:00			_NOTE_: The single most important option by far is `g:signify_vcs_list`. Please
README: typo: g:signify-option-vcs_list References #160. 2015-05-21 14:49:55 -04:00			read `:h g:signify_vcs_list`.
README: stress importance of the vcs list 2013-12-01 06:04:58 -05:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`## Demo`

			`![Example:signify in action](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-demo.gif)`

			`## Author and Feedback`

			`If you like my plugins, please star them on Github. It's a great way of getting`
			`feedback. Same goes for issues reports or feature requests.`

			`Contact:`
			`[Mail](mailto:mh.codebro@gmail.com) \|`
			`[Twitter](https://twitter.com/_mhinz_) \|`
			`[Gitter](https://gitter.im/mhinz/mhinz)`

			`Co-maintainer: [@jamessan](https://github.com/jamessan)`
add README 2013-03-05 14:07:37 -05:00
README: complete revamp 2015-12-27 17:09:26 -05:00			`_Get your Vim on!_`