Browse Source

vault: deprecate and update README

Fixes #6805
Marc Cornellà 5 years ago
parent
commit
482587ccc1
1 changed files with 8 additions and 11 deletions
  1. 8 11
      plugins/vault/README.md

+ 8 - 11
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))