From 26e7f66fcd2f86928b31232d7bbe4883c112b3ab Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 26 Jul 2024 19:29:48 +0800 Subject: [PATCH] docs(git): update README --- bundle/git.vim/README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/bundle/git.vim/README.md b/bundle/git.vim/README.md index 591e6c018..891a7354a 100644 --- a/bundle/git.vim/README.md +++ b/bundle/git.vim/README.md @@ -1,20 +1,35 @@ # git.vim +> _git.vim_ is a plugin to use _git_ command in vim and neovim. + [![](https://spacevim.org/img/build-with-SpaceVim.svg)](https://spacevim.org) - -Use git in SpaceVim - -This plugin adds extensive support for [git](https://git-scm.com/). +[![GPLv3 License](https://img.spacevim.org/license-GPLv3-blue.svg)](LICENSE) -- [usage](#usage) +- [Install](#install) +- [Usage](#usage) - [Screenshot](#screenshot) - [Feedback](#feedback) -## usage +## Install + +1. Using `git.vim` in SpaceVim: + +```toml +[[layers]] + name = 'git' +``` + +2. Using `git.vim` without SpaceVim: + +``` +Plug 'wsdjeg/git.vim' +``` + +## Usage - `:Git add %`: stage current file. - `:Git add .`: stage all files @@ -53,7 +68,6 @@ This plugin adds extensive support for [git](https://git-scm.com/). ![git-log](https://img.spacevim.org/70444048-39015900-1ad4-11ea-9522-1711c0c67098.png) - ## Feedback The development of this plugin is in [`SpaceVim/bundle/git.vim`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/git.vim) directory.