From 5b6a47e197ce6e5c5276905774dec7e7343e04aa Mon Sep 17 00:00:00 2001 From: Jon Lewis Date: Thu, 15 Feb 2018 11:40:54 -0600 Subject: [PATCH] Slight documentation tweaks --- README.md | 6 ++++-- vns | 13 +++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5b82c94..5a50d5e 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,14 @@ but instead could use the tools already provided by the operating system. usage: vns [-cedlp] vns [-hi] + vns git ... + -c | --create : Create note -d | --delete : Delete note -e | --edit : Open note for editing -h | --help : Display this message - -i | --init : Write default config and initalize VNS store" - -l | --list : List all notes in NOTEBOOK + -i | --init : Initialize note store" + -l | --list : List all notes in -p | --print : Print note to console ## Installing diff --git a/vns b/vns index 8ea0911..527cce3 100755 --- a/vns +++ b/vns @@ -99,8 +99,8 @@ vns_printHelp (){ printf "\n%s" " -d | --delete : Delete note" printf "\n%s" " -e | --edit : Open note for editing" printf "\n%s" " -h | --help : Display this message" - printf "\n%s" " -i | --init : Write default config and initalize VNS store" - printf "\n%s" " -l | --list : List all notes in NOTEBOOK" + printf "\n%s" " -i | --init : Initialize note store" + printf "\n%s" " -l | --list : List all notes in " printf "\n%s" " -p | --print : Print note to console" printf "\n\n" @@ -156,7 +156,7 @@ vns_rm () { vns_create () { # create (note) - # Edit a previously non-existant note + # Create a new note and open it for editing # Verify $1 is bound if [ -z "${*:1:1}" ]; then vns_raise "Insufficient arguments" 11; fi @@ -186,12 +186,12 @@ vns_create () { vns_edit () { # edit (note) - # edit (note) in the store + # Open (note) for editing in Vim # Verify $1 is bound if [ -z "${*:1:1}" ]; then vns_raise "Insufficient arguments" 11; fi - # Refuse to edit non-existant notes + # Refuse to edit non-existent notes if [ ! -r "$VNS_STORE/$1.gpg" ]; then vns_raise "Note not found: $1" 41; fi # Edit the specified note @@ -245,9 +245,6 @@ vns () { "${ACTIONS["$1"]}" "${@:2}" fi - # Print an extra newline just in case - # printf "\n"; - exit 0; }