summaryrefslogtreecommitdiff
path: root/plugins/vault
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-04-08 20:39:21 +0200
committerGitHub <noreply@github.com>2019-04-08 20:39:21 +0200
commit482587ccc16da0a399f3f91ef4d29def8d22a441 (patch)
tree111e686ec62fb16fcb05abfaa71a9d590a1af3ca /plugins/vault
parent8c95c2b6cb339379dda5e39a0eef795cab1dae7a (diff)
downloadzsh-482587ccc16da0a399f3f91ef4d29def8d22a441.tar.gz
zsh-482587ccc16da0a399f3f91ef4d29def8d22a441.tar.bz2
zsh-482587ccc16da0a399f3f91ef4d29def8d22a441.zip
vault: deprecate and update README
Fixes #6805
Diffstat (limited to 'plugins/vault')
-rw-r--r--plugins/vault/README.md19
1 files changed, 8 insertions, 11 deletions
diff --git a/plugins/vault/README.md b/plugins/vault/README.md
index 5cdbb16f0..69051d2b2 100644
--- a/plugins/vault/README.md
+++ b/plugins/vault/README.md
@@ -1,18 +1,15 @@
-## Vault (https://www.vaultproject.io) autocomplete plugin
+# Vault plugin
-- Adds autocomplete options for all vault commands.
+Note: this plugin is deprecated. Use the [official autocompletion](https://www.vaultproject.io/docs/commands/index.html#autocompletion) instead.
-####Show help for all commands
-![General Help](https://i.imgur.com/yv5Db1r.png "Help for all commands")
+-------
+Adds autocomplete options for all [vault](https://www.vaultproject.io) commands.
-####Create new Vault token
-![Create token](https://i.imgur.com/xMegNgh.png "Create token")
-
-
-####Enable audit backends
-![Audit backends](https://i.imgur.com/fKLeiSF.png "Audit backends")
-
+To use it, add `vault` to the plugins array in your zshrc file:
+```zsh
+plugins=(... vault)
+```
Crafted with <3 by Valentin Bud ([@valentinbud](https://twitter.com/valentinbud))