From 2bc8a8fe72778e9c51c53f65e865882768aceadf Mon Sep 17 00:00:00 2001 From: Vera Lewis Date: Wed, 17 Dec 2025 23:17:19 -0600 Subject: [PATCH] Updated documentation --- README.md | 27 +++++++++++++-------------- vns | 1 + 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 51e7696..62336d2 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,10 @@ to a popular note-taking app. The thought occurred that a note system need not reinvent the wheel with its own GUI editor and proprietary file format, but instead could use the tools already provided by the operating system. - vim note system - ================== - - usage: vns [-cedlp] - vns -I + usage: vns [-cdelpqr] + vns -I GPG_RECIPIENT (GPG_RECIPIENTS...) vns -h - vns vns_git ... + vns git ... -c : Create note -d : Delete note(s) @@ -25,11 +22,13 @@ but instead could use the tools already provided by the operating system. -h : Display this message -i : import file as note -I : Initialize note store + -j : Open Daily Journal Entry -l : List all notes in -m : Merge two or more notes -p : Print note to console + -q : Query notes for expression -r : Rename/move a note - + -u : Duplicate note as given path ## Installing ### Dependencies @@ -38,15 +37,15 @@ but instead could use the tools already provided by the operating system. * tree * git - ** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after* - a note has been created. + ** Note: ** Install [vim-gnupg] before use. vns does not verify notes encrypt successfully. - To install, place `vns` in your path, and run `vns -i`. + To install, place `vns` in your path, and run `vns -I`. - vim note system will establish its note store under ~/.config/vns. - The location of the store may be changed on line 6. + vim note system will establish its note store under ~/.vns. + The location of the store may be changed on line 4, or via the envioronment + variable VNS_STORE. - To uninstall, remove the files you copied. Notes will still exist in ~/.config/vns + To uninstall, remove the files you copied. Notes will still exist in ~/.vns ## Tips and Tricks * To list all notes in all notebooks, simply run `vns`. @@ -67,7 +66,7 @@ Version 2, as detailed in `LICENSE`. If something seems off, or just doesn't work, please open an issue and I'll look into it. -Feature requests should be submitted to vera.lewis@xenami.net with [VNS Feature Request] +Feature requests should be submitted to xenami@xenami.net with [VNS Feature Request] in the subject line. [pass]: http://passwordstore.org diff --git a/vns b/vns index dba6948..f0f0541 100644 --- a/vns +++ b/vns @@ -150,6 +150,7 @@ vns_printHelp (){ printf "\\n%s" " -h : Display this message" printf "\\n%s" " -i : import file as note" printf "\\n%s" " -I : Initialize note store" + printf "\\n%s" " -j : Open Daily Journal Entry" printf "\\n%s" " -l : List all notes in " printf "\\n%s" " -m : Merge two or more notes" printf "\\n%s" " -p : Print note to console"