docs: modernize readme, move config to vimdoc
This commit is contained in:
parent
eacae18933
commit
f73b613a33
2 changed files with 26 additions and 46 deletions
29
README.md
29
README.md
|
|
@ -1,10 +1,11 @@
|
|||
# http-codes.nvim
|
||||
|
||||
Quickly investigate HTTP status codes with the help of [Mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP), with telescope, fzf-lua, and snacks.nvim integrations.
|
||||
Quickly investigate HTTP status codes with [Mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP), with telescope, fzf-lua, and snacks.nvim integrations.
|
||||
|
||||
## Installation
|
||||
|
||||
Install using your package manager of choice or via [luarocks](https://luarocks.org/modules/barrettruth/http-codes.nvim):
|
||||
Install with your package manager or via
|
||||
[luarocks](https://luarocks.org/modules/barrettruth/http-codes.nvim):
|
||||
|
||||
```
|
||||
luarocks install http-codes.nvim
|
||||
|
|
@ -13,34 +14,10 @@ luarocks install http-codes.nvim
|
|||
## Dependencies
|
||||
|
||||
One of:
|
||||
|
||||
- [fzf-lua](https://github.com/ibhagwan/fzf-lua)
|
||||
- [snacks.nvim](https://github.com/folke/snacks.nvim)
|
||||
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
|
||||
|
||||
## Configuration
|
||||
|
||||
Configure via `vim.g.http_codes` before the plugin loads:
|
||||
|
||||
```lua
|
||||
vim.g.http_codes = {
|
||||
use = 'fzf-lua', -- or 'snacks' or 'telescope', auto-detected by default
|
||||
open_url = 'xdg-open %s', -- OS-specific by default
|
||||
}
|
||||
```
|
||||
|
||||
| OS | Default open_url |
|
||||
| ------- | ---------------- |
|
||||
| Windows | `start %s` |
|
||||
| macOS | `open %s` |
|
||||
| Linux | `xdg-open %s` |
|
||||
|
||||
## Usage
|
||||
|
||||
```vim
|
||||
:HTTPCodes
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
```vim
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue