feat: initial release

doc/tiny-lightbulb.txt

@@ -0,0 +1,68 @@
+*tiny-lightbulb.txt*  Show a sign when LSP code actions are available
+
+Author: Stephen Waits <https://github.com/swaits>
+License: MIT
+
+==============================================================================
+CONTENTS                                          *tiny-lightbulb-contents*
+
+  1. Introduction ............................ |tiny-lightbulb-introduction|
+  2. Requirements ............................ |tiny-lightbulb-requirements|
+  3. Installation ............................ |tiny-lightbulb-installation|
+  4. Configuration ........................... |tiny-lightbulb-configuration|
+
+==============================================================================
+1. INTRODUCTION                                *tiny-lightbulb-introduction*
+
+tiny-lightbulb.nvim displays a sign in the sign column when LSP code actions
+are available for the current line. Works out of the box with zero
+configuration — just install and go.
+
+==============================================================================
+2. REQUIREMENTS                                *tiny-lightbulb-requirements*
+
+- Neovim >= 0.12
+- At least one LSP server that supports code actions
+
+==============================================================================
+3. INSTALLATION                                *tiny-lightbulb-installation*
+
+Add to your |vim.pack.add()| call: >lua
+
+    "https://github.com/swaits/tiny-lightbulb.nvim",
+<
+That's it. The plugin auto-loads with defaults. To customize, call setup: >lua
+
+    require("tiny-lightbulb").setup({
+      sign = "💡",
+      hl = "DiagnosticWarn",
+      priority = 10,
+    })
+<
+==============================================================================
+4. CONFIGURATION                              *tiny-lightbulb-configuration*
+
+                                                  *tiny-lightbulb.setup()*
+setup({opts})
+
+    Optional. The plugin works with defaults if you never call this.
+    Calling setup reconfigures the plugin with the given options.
+
+    All options shown with defaults: >lua
+
+        require("tiny-lightbulb").setup({
+          sign = "💡",         -- sign column text
+          hl = "DiagnosticWarn", -- highlight group for the sign
+          priority = 10,        -- extmark priority
+        })
+<
+    Parameters: ~
+      {opts}  (table|nil) Configuration table
+
+    Fields: ~
+      {sign}      (string) Text shown in the sign column. Default: "💡"
+      {hl}        (string) Highlight group for the sign. Default: "DiagnosticWarn"
+      {priority}  (number) Extmark priority. Default: 10
+
+==============================================================================
+vim:tw=78:ts=8:ft=help:norl: