Skip to content

Commit

Permalink
doc: install (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
linrongbin16 authored Sep 4, 2023
1 parent bc1c680 commit 3cc5ff8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

# gitlinker.nvim

<p align="center">
<a href="https://github.com/neovim/neovim/releases/stable"><img alt="Neovim-v0.5" src="https://img.shields.io/badge/Neovim-v0.5-blueviolet.svg?logo=Neovim&logoColor=green" /></a>
<a href="https://github.com/linrongbin16/gitlinker.nvim/search?l=lua"><img alt="Top Language" src="https://img.shields.io/github/languages/top/linrongbin16/gitlinker.nvim?label=Lua&logo=lua&logoColor=darkblue" /></a>
<a href="https://github.com/linrongbin16/gitlinker.nvim/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/linrongbin16/gitlinker.nvim?logo=GNU&label=License" /></a>
<!-- <a href="https://github.com/linrongbin16/fzfx.nvim/actions/workflows/ci.yml"><img alt="ci.yml" src="https://img.shields.io/github/actions/workflow/status/linrongbin16/fzfx.nvim/ci.yml?logo=GitHub&label=Luacheck" /></a> -->
</p>

> A fork of [ruifm's gitlinker](https://github.com/ruifm/gitlinker.nvim), refactored
> with pattern based rule engine, Windows support and other enhancements.
Expand Down Expand Up @@ -62,7 +69,6 @@ Requirement:
```lua
use {
'linrongbin16/gitlinker.nvim',
branch = 'master',
config = function()
require('gitlinker').setup()
end,
Expand All @@ -74,7 +80,7 @@ use {
```vim
call plug#begin()
Plug 'linrongbin16/gitlinker.nvim', { 'branch': 'master' }
Plug 'linrongbin16/gitlinker.nvim'
call plug#end()
Expand Down

0 comments on commit 3cc5ff8

Please sign in to comment.