From dceddc1e3fc2d345e5ca9f76a4eb2f2393889317 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Mon, 17 Jun 2024 21:09:48 -0500 Subject: [PATCH] feat: improve readme clarity --- readme.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 6fe0afe..0b2b41f 100644 --- a/readme.md +++ b/readme.md @@ -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: