diff --git a/CHANGELOG.md b/CHANGELOG.md index 802aa0b..4bb6d12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial release - Lightbulb sign when LSP code actions are available on current line - Async LSP requests with generation-counter stale-response handling -- Configurable sign text, highlight group, and extmark priority +- Configurable sign text and highlight group - Zero-config auto-loading via `plugin/` directory [0.1.0]: https://github.com/swaits/tiny-lightbulb.nvim/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 91ef959..0df621a 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,18 @@ Add to your `vim.pack.add()` call: Done. The plugin auto-loads with sensible defaults. +## Recommended setup + +To prevent the gutter from expanding and contracting as the lightbulb +appears and disappears, reserve the sign column width up front: + +```lua +vim.o.signcolumn = "yes:2" -- room for a diagnostic + the lightbulb +``` + +Without this, Neovim's default `auto` behavior will shift your text left +and right as signs come and go. + ## Configuration All options are optional. Call `setup()` only if you want to customize: