From 3f6aeea8c795b8bff59c1a8b45700d7bc44da4b9 Mon Sep 17 00:00:00 2001
From: Guangxiong Lin <hi@gxlin.org>
Date: Fri, 20 Jan 2023 23:05:54 +0800
Subject: First commit

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf54bf6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# zk
+
+A commandline tool to help organize markdown notes.
+
+By default, the current working directory is taken as the root directory
+of markdown notes.
+
+Created for personal use. **USE IT AT YOUR OWN RISK.**
+
+Install:
+
+```
+make install
+```
+
+Usage:
+
+- `zk mv path/to/source path/to/target`: The same as `mv`. However,
+  backlinks are updated together.
+
+  - **The source and target paths cannot be directories.**
-- 
cgit v1.2.3