From bffcccb893de306fbab01082888356a30d9ea69e Mon Sep 17 00:00:00 2001
From: moxie <moxie@3kgcat.fi>
Date: Tue, 17 Mar 2026 09:03:45 +0200
Subject: chore: update readme/docs

---
 README.md | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 47b924e..095637e 100644
--- a/README.md
+++ b/README.md
@@ -10,8 +10,9 @@ A lightweight wiki plugin for Neovim using standard markdown syntax.
 ## Features
 
 - Standard markdown links `[text](url)`
-- Multiple wiki directories
 - Link navigation and xdg-open for web/file links
+- Multiple wiki directories
+- Hierarchical checkbox toggling for TODO list
 - Extensible via autocmds (mkdir, templates, custom handlers)
 
 See `:help muwiki` for complete documentation and configuration options.
@@ -23,7 +24,7 @@ See `:help muwiki` for complete documentation and configuration options.
 ```lua
 vim.pack.add({
   { src = "https://git.3kgcat.fi/muwiki.nvim", name = "muwiki" }
-  { src = "https://github.com/nvim-treesitter/nvim-treesitter", name = "treesitter" }
+  { src = "https://github.com/nvim-treesitter/nvim-treesitter" }
 })
 ```
 
@@ -52,10 +53,16 @@ vim.pack.add({
       callback = function(ev)
         if not muwiki.wiki_root(ev.buf) then return end
         local keymap_opts = { buffer = ev.buf, silent = true, nowait = true }
+        keymap_opts.desc = "Open link"
         vim.keymap.set('n', '<CR>', muwiki.open_link, keymap_opts)
+        keymap_opts.desc = "Next link"
         vim.keymap.set('n', '<Tab>', muwiki.next_link, keymap_opts)
+        keymap_opts.desc = "Previous link"
         vim.keymap.set('n', '<S-Tab>', muwiki.prev_link, keymap_opts)
+        keymap_opts.desc = "Create link"
         vim.keymap.set('v', '<CR>', muwiki.create_link, keymap_opts)
+        keymap_opts.desc = "Toggle checkbox"
+        vim.keymap.set('n', '<S-t>', muwiki.toggle_checkbox, keymap_opts)
       end,
     })
   end,
@@ -86,11 +93,17 @@ vim.api.nvim_create_autocmd("FileType", {
   callback = function(args)
     if not muwiki.wiki_root(args.buf) then return end
 
-    local opts = { buffer = args.buf, silent = true }
-    vim.keymap.set('n', '<CR>', muwiki.open_link, opts)
-    vim.keymap.set('n', '<Tab>', muwiki.next_link, opts)
-    vim.keymap.set('n', '<S-Tab>', muwiki.prev_link, opts)
-    vim.keymap.set('v', '<CR>', muwiki.create_link, opts)
+    local keymap_opts = { buffer = args.buf, silent = true }
+    keymap_opts.desc = "Open link"
+    vim.keymap.set('n', '<CR>', muwiki.open_link, keymap_opts)
+    keymap_opts.desc = "Next link"
+    vim.keymap.set('n', '<Tab>', muwiki.next_link, keymap_opts)
+    keymap_opts.desc = "Previous link"
+    vim.keymap.set('n', '<S-Tab>', muwiki.prev_link, keymap_opts)
+    keymap_opts.desc = "Create link"
+    vim.keymap.set('v', '<CR>', muwiki.create_link, keymap_opts)
+    keymap_opts.desc = "Toggle checkbox"
+    vim.keymap.set('n', '<S-t>', muwiki.toggle_checkbox, keymap_opts)
   end,
 })
 
-- 
cgit v1.2.3