From b0aa79433a60d1606d3d5bc9ff642370196cdb1f Mon Sep 17 00:00:00 2001
From: Eric Wong <wsdjeg@outlook.com>
Date: Wed, 18 Dec 2024 00:46:21 +0800
Subject: [PATCH] docs(zettelkasten): update readme

---
 bundle/vim-zettelkasten/README.md     | 30 +++++++++++++++++++++++++++
 bundle/vim-zettelkasten/test/init.vim |  1 +
 2 files changed, 31 insertions(+)

diff --git a/bundle/vim-zettelkasten/README.md b/bundle/vim-zettelkasten/README.md
index 19061dfb6..5728b1fcf 100644
--- a/bundle/vim-zettelkasten/README.md
+++ b/bundle/vim-zettelkasten/README.md
@@ -8,6 +8,8 @@
 <!-- vim-markdown-toc GFM -->
 
 - [Install](#install)
+- [Usage](#usage)
+- [Screenshots](#screenshots)
 - [Feedback](#feedback)
 
 <!-- vim-markdown-toc -->
@@ -31,6 +33,34 @@ let g:zettelkasten_directory = 'D:\me\zettelkasten'
 let g:zettelkasten_template_directory = 'D:\me\zettelkasten_template'
 ```
 
+## Usage
+
+**Commands:**
+
+| Command           | description                       |
+| ----------------- | --------------------------------- |
+| `:ZkNew`          | create new note                   |
+| `:ZkBrowse`       | list note in browser window       |
+| `:ZkListTags`     | filter tags in telescope          |
+| `:ZkListTemplete` | filte note templates in telescope |
+
+**Key bindings in browser window:**
+
+| key bindings    | description                        |
+| --------------- | ---------------------------------- |
+| `F2`            | open zettelkasten tags sidebar     |
+| `<LeftRelease>` | filter notes based on cursor tag   |
+| `gf`            | open the note                      |
+| `Ctrl-l`        | clear tags filter pattarn          |
+| `Ctrl-] / K`    | preview note in vim preview-window |
+| `[I`            | list references in quickfix-window |
+
+## Screenshots
+
+![](https://wsdjeg.net/images/zkbrowser.png)
+![](https://wsdjeg.net/images/zettelkasten-tags-sidebar.png)
+![](https://wsdjeg.net/images/zettelkasten-tags-filter.png)
+![](https://wsdjeg.net/images/zettelkasten-complete-id.png)
 
 ## Feedback
 
diff --git a/bundle/vim-zettelkasten/test/init.vim b/bundle/vim-zettelkasten/test/init.vim
index d1aeb2a32..52044b518 100644
--- a/bundle/vim-zettelkasten/test/init.vim
+++ b/bundle/vim-zettelkasten/test/init.vim
@@ -1 +1,2 @@
 exe 'set rtp+=' .. getcwd()
+colorscheme default