docs(git): update README

wsdjeg · Jul 26, 2024 · 26e7f66 · 26e7f66
1 parent 79d7fab
commit 26e7f66
Showing 1 changed file with 21 additions and 7 deletions.
diff --git a/bundle/git.vim/README.md b/bundle/git.vim/README.md
@@ -1,20 +1,35 @@
 # git.vim
 
-[![](https://spacevim.org/img/build-with-SpaceVim.svg)](https://spacevim.org)
-
-Use git in SpaceVim
+> _git.vim_ is a plugin to use _git_ command in vim and neovim.
 
-This plugin adds extensive support for [git](https://git-scm.com/). 
+[![](https://spacevim.org/img/build-with-SpaceVim.svg)](https://spacevim.org)
+[![GPLv3 License](https://img.spacevim.org/license-GPLv3-blue.svg)](LICENSE)
 
 <!-- vim-markdown-toc GFM -->
 
-- [usage](#usage)
+- [Install](#install)
+- [Usage](#usage)
 - [Screenshot](#screenshot)
 - [Feedback](#feedback)
 
 <!-- vim-markdown-toc -->
 
-## 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.