From 908b93242c52fba1bf6bd0453c624f5ca6685f32 Mon Sep 17 00:00:00 2001 From: Jon-William Lewis Date: Sat, 31 Oct 2015 14:24:33 -0500 Subject: [PATCH] Added initial readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..41e571c --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +Simple Note System +================== + +The Simple Note System is a shell script enabling easy management of plain-text +notes. SNS depends on OpenSSL for encryption and uses the vim editor by default. + + usage: sns [-ce] NAME NOTEBOOK SECTION" + sns [-d ] NAME NOTEBOOK SECTION" + sns [-lp] NOTEBOOK" + sns [-w ]" + sns [-h ]" + + -c | --create : Create note" + -d | --delete : Delete note" + -e | --edit : Open note for editing" + -h | --help : Display this message" + -p | --print : Print note to console" + -l | --list : List all notes in NOTEBOOK" + -w | --wconf : Rewrite default configuration"