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.

VNS, originally 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
    ==================

    usage: vns [-cedlp] <notebook/section/name>
           vns [-hi]
      -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
      -p | --print  : Print note to console

## Installing
### Notice:
To migrate from SNS, simply move
$HOME/.local/sns to $HOME/.local/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.

To uninstall, remove the files you copied. Notes will still exist in $HOME/.local/vns

Once installed, VNS will require you to run `sns -i [gpgkey]`, 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`


**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.

## Tips and Tricks
* To list all notes in all notebooks, use `sns -l .`

## Credits
The code here is my own, however much of VNS's design and behavior was
influenced by [pass].

## License
Vim Note System is licensed under the terms of the GNU General Public License
Version 2, as detailed in `LICENSE`.

## Bugs and Feature Requests
If something seems off, or just doesn't work, please open an issue and I'll look
into it.

Feature requests should be submitted to jon.lewis@xenami.net with [SNS Feature Request]
in the subject line.

[pass]: http://passwordstore.org
[vim-gnupg]:http://www.vim.org/scripts/script.php?script_id=3645