feat: improve readme clarity
This commit is contained in:
parent
46ebe4ded7
commit
dceddc1e3f
1 changed files with 13 additions and 9 deletions
22
readme.md
22
readme.md
|
|
@ -10,15 +10,7 @@ Install via your favorite package manager, like [lazy](https://github.com/folke/
|
||||||
require('lazy').setup({
|
require('lazy').setup({
|
||||||
{
|
{
|
||||||
'barrett-ruth/http-codes.nvim'
|
'barrett-ruth/http-codes.nvim'
|
||||||
opts = {
|
config = true,
|
||||||
-- defaults to available picker: 'fzf-lua' or 'telescope'
|
|
||||||
use = 'fzf-lua'
|
|
||||||
-- How the mozilla url is opened.
|
|
||||||
-- Configured by default based on OS:
|
|
||||||
open_url = 'xdg-open %s' -- UNIX
|
|
||||||
-- = 'open %s' -- OSX
|
|
||||||
-- = 'start %s' -- Windows
|
|
||||||
},
|
|
||||||
-- or 'nvim-telescope/telescope.nvim'
|
-- or 'nvim-telescope/telescope.nvim'
|
||||||
dependencies = 'ibhagwan/fzf-lua'
|
dependencies = 'ibhagwan/fzf-lua'
|
||||||
}
|
}
|
||||||
|
|
@ -27,6 +19,18 @@ require('lazy').setup({
|
||||||
|
|
||||||
## [Configuration](./doc/http-codes.txt)
|
## [Configuration](./doc/http-codes.txt)
|
||||||
|
|
||||||
|
`http-codes.nvim` uses telescope or fzf-lua (whichever you've installed), which can be manually overriden.
|
||||||
|
|
||||||
|
`http-codes.nvim` opens the Mozilla documentation URLs based on your operating system. This can be overriden.
|
||||||
|
|
||||||
|
| OS | open_url |
|
||||||
|
| ------- | ------------- |
|
||||||
|
| Windows | `start %s` |
|
||||||
|
| OSX | `open %s` |
|
||||||
|
| UNIX | `xdg-open %s` |
|
||||||
|
|
||||||
|
See [the docs](./doc/http-codes.txt) for more information.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use the exposed command in vimscript:
|
Use the exposed command in vimscript:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue