diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
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.** |