fix: Fixes readme.
This commit is contained in:
27
README.md
27
README.md
@@ -1,3 +1,28 @@
|
||||
# shortenurl.nvim
|
||||
|
||||
Small neovim plugin to shorten urls, using shlink and the shorten-url scripts in my dotfiles.
|
||||
This is a small neovim plugin that can convert urls to short urls, using the `shoren-url` bash script found in my
|
||||
dotfiles repo.
|
||||
|
||||
## Usage
|
||||
|
||||
```lua
|
||||
vim.pack.add({
|
||||
{ src = "https://git.housh.dev/michael/shortenurl.nvm" },
|
||||
})
|
||||
```
|
||||
|
||||
### Create keybinds
|
||||
|
||||
```lua
|
||||
vim.keymap.set({ 'n', 'v', 'x' }, '<leader>lc', function()
|
||||
require('shortenurl').convertUrl()
|
||||
end, { desc = "[L]ink [c]onvert to short url." })
|
||||
|
||||
vim.keymap.set('n', '<leader>ls', function()
|
||||
require('shortenurl').prompt()
|
||||
end, { desc = "[L]ink [s]horten, prompting for url." })
|
||||
|
||||
vim.keymap.set('n', '<leader>lv', function()
|
||||
require('shortenurl').convertFromClipboard()
|
||||
end, { desc = "[L]ink convert url from cliboard to short url." })
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user