docs: add instructions for smear in insert mode

sphamba · Jan 21, 2025 · 31eff34 · 31eff34
1 parent 1cf9044
commit 31eff34
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -72,6 +72,10 @@ return {
     -- Set to `true` if your font supports legacy computing symbols (block unicode symbols).
     -- Smears will blend better on all backgrounds.
     legacy_computing_symbols_support = false,
+
+    -- Smear cursor in insert mode.
+    -- See also `vertical_bar_cursor_insert_mode` and `distance_stop_animating_vertical_bar`.
+    smear_insert_mode = true,
   },
 }
 ```

diff --git a/lua/smear_cursor/config.lua b/lua/smear_cursor/config.lua
@@ -29,7 +29,8 @@ M.legacy_computing_symbols_support = false
 -- Set to `true` if your cursor is a vertical bar in normal mode.
 M.vertical_bar_cursor = false
 
--- Smear cursor in insert mode
+-- Smear cursor in insert mode.
+-- See also `vertical_bar_cursor_insert_mode` and `distance_stop_animating_vertical_bar`.
 M.smear_insert_mode = true
 
 -- Set to `true` if your cursor is a vertical bar in insert mode.