xenami/vns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Jon Lewis
2018-02-05 17:59:00 -06:00
parent 21239b9442
commit f6e10cf6a5
1 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -2,19 +2,15 @@ Vim Note System
==================
## About
The Vim Note System is a shell script partially inspired by [pass], in that
it stores notes as normal, plaintext, files in normal folders. It uses the
vim-gnupg plugin, and asymmetric GPG encryption.
Vim Note System is a shell script partially inspired by [pass].
vns stores notes as asymmetrically encrypted plaintext using the
vim-gnupg plugin.
VNS, originally SNS, was originally conceived one morning during an update
VNS, formerly SNS, was originally conceived one morning during an update
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.
As it developed, OpenSSL encryption was dropped in favor of GPG, and the script
was almost entirely rewritten as SNSv2, rewritten again as SNS v2a, and forked
as VNS 1.0.
vim note system
==================
@@ -31,29 +27,29 @@ as VNS 1.0.
## Installing
### Notice:
To migrate from SNS, simply move
$HOME/.local/sns to $HOME/.local/vns,
$HOME/.local/sns to $HOME/.config/vns,
then append ".gpg" to each note name, for example
`find "$HOME/.local/vns" -type f -exec mv {} {}.gpg \;`
To install, place `vns` in your path,
** Note: ** Install [vim-gnupg] before use.
** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after*
the first note has been created.
To uninstall, remove the files you copied. Notes will still exist in $HOME/.local/vns
To uninstall, remove the files you copied. Notes will still exist in $HOME/.config/vns
Once installed, VNS will require you to run `sns -i [gpgkey]`, to indicate you would like
Once installed, vns will require you to run `vns -i`, to indicate you would like
to create its note store and write its default configuration.
By default, VNS will set itself up in `~/.local/vns`
By default, vns will set itself up in `~/.config/vns`
This behaviour is defined on line 6.
**A word about encryption:**
Encryption is handled by the vim-gnupg plugin. By default, the plugin creates temporary files on disk to
edit GPG-encrypted files. Setting `let g:GPGUsePipes=1` in .vimrc will bypass the creation of these files,
but the plugin author warns doing so may break certain CLI-based GPG agents.
Encryption is handled by the vim-gnupg plugin.
## Tips and Tricks
* To list all notes in all notebooks, use `sns -l .`
* To list all notes in all notebooks, simply run `vns`.
## Credits
The code here is my own, however much of VNS's design and behavior was