From 9e99a782715941c725bec08dc6729d0b6b292e03 Mon Sep 17 00:00:00 2001 From: Andy Stewart Date: Thu, 23 Apr 2020 09:02:22 +0100 Subject: [PATCH] Document the reason for the name gitgutter --- README.mkd | 4 +++- doc/gitgutter.txt | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.mkd b/README.mkd index 3169e2d..6ec754d 100644 --- a/README.mkd +++ b/README.mkd @@ -1,9 +1,11 @@ ## vim-gitgutter -A Vim plugin which shows a git diff in the 'gutter' (sign column). It shows which lines have been added, modified, or removed. You can also preview, stage, and undo individual hunks; and stage partial hunks. The plugin also provides a hunk text object. +A Vim plugin which shows a git diff in the sign column. It shows which lines have been added, modified, or removed. You can also preview, stage, and undo individual hunks; and stage partial hunks. The plugin also provides a hunk text object. The signs are always up to date and the plugin never saves your buffer. +The name "gitgutter" comes from the Sublime Text 3 plugin which inspired this one in 2013. + Features: * Shows signs for added, modified, and removed lines. diff --git a/doc/gitgutter.txt b/doc/gitgutter.txt index 1eb3fea..b2278c8 100644 --- a/doc/gitgutter.txt +++ b/doc/gitgutter.txt @@ -1,7 +1,7 @@ *gitgutter.txt* A Vim plugin which shows a git diff in the gutter. - Vim Git Gutter + Vim GitGutter Author: Andy Stewart @@ -27,13 +27,16 @@ CONTENTS *gitgutter* =============================================================================== INTRODUCTION *gitgutter-introduction* -GitGutter is a Vim plugin which shows a git diff in the 'gutter' (sign column). +GitGutter is a Vim plugin which shows a git diff in the sign column. It shows which lines have been added, modified, or removed. You can also preview, stage, and undo individual hunks. The plugin also provides a hunk text object. The signs are always up to date and the plugin never saves your buffer. +The name "gitgutter" comes from the Sublime Text 3 plugin which inspired this +one in 2013. + =============================================================================== INSTALLATION *gitgutter-installation*