docs: modernize readme, move config to vimdoc

This commit is contained in:
Barrett Ruth 2026-02-03 22:33:05 -05:00
parent eacae18933
commit f73b613a33
2 changed files with 26 additions and 46 deletions

View file

@ -1,10 +1,11 @@
# http-codes.nvim # 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 ## 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 luarocks install http-codes.nvim
@ -13,34 +14,10 @@ luarocks install http-codes.nvim
## Dependencies ## Dependencies
One of: One of:
- [fzf-lua](https://github.com/ibhagwan/fzf-lua) - [fzf-lua](https://github.com/ibhagwan/fzf-lua)
- [snacks.nvim](https://github.com/folke/snacks.nvim) - [snacks.nvim](https://github.com/folke/snacks.nvim)
- [telescope.nvim](https://github.com/nvim-telescope/telescope.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 ## Documentation
```vim ```vim

View file

@ -1,39 +1,42 @@
http-codes *http-codes.txt* *http-codes* *http-codes.txt*
Author: Barrett Ruth <https://barrettruth.com> Author: Barrett Ruth <https://barrettruth.com>
Homepage: <https://github.com/barrettruth/http-codes.nvim> Homepage: <https://github.com/barrett-ruth/http-codes.nvim>
=============================================================================== ===============================================================================
INTRODUCTION *http-codes.nvim* INTRODUCTION *http-codes.nvim*
http-codes.nvim lets you quickly investigate HTTP status codes with Mozilla, http-codes.nvim lets you quickly investigate HTTP status codes using Mozilla
supporting fzf-lua, snacks.nvim, and telescope.nvim. documentation, with telescope, fzf-lua, and snacks.nvim integrations.
=============================================================================== ===============================================================================
CONFIGURATION *http-codes.config* USAGE *:HTTPCodes*
>vim
:HTTPCodes
<
===============================================================================
CONFIGURATION *vim.g.http_codes*
Configure via `vim.g.http_codes`:
Configure via `vim.g.http_codes` before the plugin loads:
>lua >lua
vim.g.http_codes = { vim.g.http_codes = {
-- Picker: 'fzf-lua', 'snacks', or 'telescope' (auto-detected)
use = 'fzf-lua', use = 'fzf-lua',
-- Command to open URLs (OS-specific by default)
open_url = 'xdg-open %s', open_url = 'xdg-open %s',
} }
< <
Options: ~
{use} `(string|nil)`: Picker to use: 'fzf-lua', 'snacks', or Default `open_url` by operating system:
'telescope'. Auto-detected if not specified.
{open_url} `(string|nil)`: Command to open URLs. Uses `%s` as placeholder. OS Default
Defaults based on OS: -------- ---------------
- Linux: 'xdg-open %s' Windows start %s
- macOS: 'open %s' macOS open %s
- Windows: 'start %s' Linux xdg-open %s
===============================================================================
COMMANDS *http-codes.commands*
:HTTPCodes Browse HTTP codes using the configured picker.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
vim:tw=80:ft=help: vim:tw=80:ts=8:ft=help: