feat: improve readme clarity

This commit is contained in:
Barrett Ruth 2024-06-17 21:09:48 -05:00
parent 46ebe4ded7
commit dceddc1e3f

View file

@ -10,15 +10,7 @@ Install via your favorite package manager, like [lazy](https://github.com/folke/
require('lazy').setup({
{
'barrett-ruth/http-codes.nvim'
opts = {
-- 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
},
config = true,
-- or 'nvim-telescope/telescope.nvim'
dependencies = 'ibhagwan/fzf-lua'
}
@ -27,6 +19,18 @@ require('lazy').setup({
## [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
Use the exposed command in vimscript: