Added initial readme

This commit is contained in:
Jon-William Lewis
2015-10-31 14:24:33 -05:00
parent 631d52689e
commit 908b93242c

19
README.md Normal file
View File

@@ -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"