aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-06-17 22:44:07 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-06-17 22:44:07 +1200
commitbafac542ef80d627ea9155e522a9ec181c76faa3 (patch)
tree67a2efbf11b60e27208efd0005de149743b5b5aa /README.md
parentAdd version guard (diff)
downloadvim-redact-pass-bafac542ef80d627ea9155e522a9ec181c76faa3.tar.gz
vim-redact-pass-bafac542ef80d627ea9155e522a9ec181c76faa3.zip
Rename to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eeee26b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+redact\_pass.vim
+================
+
+This plugin switches off the 'viminfo', 'backup', 'writebackup', 'swapfile',
+and 'undofile' options globally when editing a password in `pass(1)`.
+
+This is to prevent anyone being able to extract passwords from your Vim cache
+files in the event of a compromise.
+
+You should test this after installed to ensure you see this message is printed
+whenever you `pass edit`:
+
+> Editing password file--disabled leaky options!
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+
+[1]: https://sanctum.geek.nz/