docs: note on visible state with example

Signed-off-by: Osamu Aoki <[email protected]>
tris203 · Jun 16, 2024 · e019b24 · e019b24
1 parent 8140b00
commit e019b24
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -80,7 +80,17 @@ or
 require("precognition").toggle()
 ```
 
-The subcommands and functions `show` and `hide` are also available.
+The return value indicating the visible state can be used to produce a notification.
+
+```lua
+if require("precognition").toggle() then
+    vim.notify("precognition on")
+else
+    vim.notify("precognition off")
+end
+```
+
+The subcommands and functions `show` and `hide` are also available with the return value indicating the visible state.
 
 ### Peeking