Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: remove 'logger' from dependency #16

Merged
merged 1 commit into from
Jun 15, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ co-workers.
## Lua pattern based rules

[Lua pattern](https://www.lua.org/pil/20.2.html) is introduced to map git remote
url to host url. The lua pattern has many limitations compared with the [standard regex expression](https://en.wikipedia.org/wiki/Regular_expression),
url to host url. The lua pattern has many limitations compared with the
[standard regex expression](https://en.wikipedia.org/wiki/Regular_expression),
but it's still the best solution in git sharable file permalinks scenario.

For now github.com(include both git/http protocols and github enterprise) are supported:
Expand All @@ -40,7 +41,6 @@ PRs are welcomed for other git host websites!
- git
- neovim 0.8
- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
- [logger.nvim](https://github.com/linrongbin16/logger.nvim)

## Installation

Expand All @@ -49,10 +49,7 @@ PRs are welcomed for other git host websites!
```lua
use {
'linrongbin16/gitlinker.nvim',
requires = {
'nvim-lua/plenary.nvim',
'linrongbin16/logger.nvim'
},
requires = { 'nvim-lua/plenary.nvim' },
branch = 'master',
config = function()
require('gitlinker').setup()
Expand All @@ -64,7 +61,6 @@ use {

```vim
Plug 'nvim-lua/plenary.nvim'
Plug 'linrongbin16/logger.nvim'
Plug 'linrongbin16/gitlinker.nvim', { 'branch': 'master' }
```

Expand All @@ -75,11 +71,7 @@ Then add `require('gitlinker').setup()` to your `init.lua`.
```lua
{
'linrongbin16/gitlinker.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
'linrongbin16/logger.nvim'
},
branch = 'master',
dependencies = { 'nvim-lua/plenary.nvim' },
config = function()
require('gitlinker').setup()
end,
Expand Down