Updated documentation
This commit is contained in:
15
README.md
15
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,
|
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.
|
but instead could use the tools already provided by the operating system.
|
||||||
|
|
||||||
vim note system
|
usage: vns [-cdelpqr] <notebook/section/name>
|
||||||
==================
|
vns -I GPG_RECIPIENT (GPG_RECIPIENTS...)
|
||||||
|
|
||||||
usage: vns [-cedlp] <notebook/section/name>
|
|
||||||
vns -I
|
|
||||||
vns -h
|
vns -h
|
||||||
vns vns_git ...
|
vns git ...
|
||||||
|
|
||||||
-c : Create note
|
-c : Create note
|
||||||
-d : Delete note(s)
|
-d : Delete note(s)
|
||||||
@@ -25,11 +22,13 @@ but instead could use the tools already provided by the operating system.
|
|||||||
-h : Display this message
|
-h : Display this message
|
||||||
-i : import file as note
|
-i : import file as note
|
||||||
-I : Initialize note store
|
-I : Initialize note store
|
||||||
|
-j : Open Daily Journal Entry
|
||||||
-l : List all notes in <notebook>
|
-l : List all notes in <notebook>
|
||||||
-m : Merge two or more notes
|
-m : Merge two or more notes
|
||||||
-p : Print note to console
|
-p : Print note to console
|
||||||
|
-q : Query notes for expression
|
||||||
-r : Rename/move a note
|
-r : Rename/move a note
|
||||||
|
-u : Duplicate note as given path
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
### Dependencies
|
### Dependencies
|
||||||
@@ -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
|
If something seems off, or just doesn't work, please open an issue and I'll look
|
||||||
into it.
|
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.
|
in the subject line.
|
||||||
|
|
||||||
[pass]: http://passwordstore.org
|
[pass]: http://passwordstore.org
|
||||||
|
|||||||
1
vns
1
vns
@@ -150,6 +150,7 @@ vns_printHelp (){
|
|||||||
printf "\\n%s" " -h : Display this message"
|
printf "\\n%s" " -h : Display this message"
|
||||||
printf "\\n%s" " -i : import file as note"
|
printf "\\n%s" " -i : import file as note"
|
||||||
printf "\\n%s" " -I : Initialize note store"
|
printf "\\n%s" " -I : Initialize note store"
|
||||||
|
printf "\\n%s" " -j : Open Daily Journal Entry"
|
||||||
printf "\\n%s" " -l : List all notes in <notebook>"
|
printf "\\n%s" " -l : List all notes in <notebook>"
|
||||||
printf "\\n%s" " -m : Merge two or more notes"
|
printf "\\n%s" " -m : Merge two or more notes"
|
||||||
printf "\\n%s" " -p : Print note to console"
|
printf "\\n%s" " -p : Print note to console"
|
||||||
|
|||||||
Reference in New Issue
Block a user