Update README
This commit is contained in:
parent
c7f2f95bc5
commit
0033a6f3f1
1 changed files with 26 additions and 1 deletions
27
README.md
27
README.md
|
|
@ -1,3 +1,28 @@
|
|||
# source-link.lua
|
||||
|
||||
View current file on configured git remote
|
||||
View the current line number of the current file on configured git remote.
|
||||
|
||||
## Installation
|
||||
|
||||
Call ``setup`` from your neovim configuration file:
|
||||
|
||||
```lua
|
||||
...
|
||||
local source_link = require('source_link')
|
||||
|
||||
source_link.setup()
|
||||
...
|
||||
|
||||
```
|
||||
|
||||
Optionally create a keybinding:
|
||||
|
||||
```lua
|
||||
...
|
||||
local opts = { noremap = true, silent = true }
|
||||
|
||||
vim.api.nvim_set_keymap('n', '<C-L>', '<cmd>:SourceOpen<CR>', opts)
|
||||
|
||||
```
|
||||
|
||||
Or call the command directly from Command mode: ``:SourceOpen``.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue