Vim Note System
==================

## About
Vim Note System is a shell script partially inspired by [pass].
vns stores notes as asymmetrically encrypted plaintext using the
vim-gnupg plugin.

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.

    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/.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. 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/.config/vns

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 `~/.config/vns`
This behaviour is defined on line 6.


**A word about encryption:**
Encryption is handled by the vim-gnupg plugin.

## Tips and Tricks
* To list all notes in all notebooks, simply run `vns`.
* Notes beginning with . will not appear in the listing

## 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