diff --git a/README.md b/README.md index 5a50d5e..45c90d7 100644 --- a/README.md +++ b/README.md @@ -27,28 +27,21 @@ but instead could use the tools already provided by the operating system. -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 \;` + ### Dependencies + * vim + * gpg2 + * tree + * git -To install, place `vns` in your path, + ** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after* + a note has been created. -** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after* - the first note has been created. + To install, place `vns` in your path, and run `vns -i`. -To uninstall, remove the files you copied. Notes will still exist in $HOME/.config/vns + vim note system will establish its note store under ~/.config/vns. + The location of the store may be changed on line 6. -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. + To uninstall, remove the files you copied. Notes will still exist in ~/.config/vns ## Tips and Tricks * To list all notes in all notebooks, simply run `vns`.