summaryrefslogtreecommitdiff
path: root/plugins/argocd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/argocd/README.md')
-rw-r--r--plugins/argocd/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/argocd/README.md b/plugins/argocd/README.md
new file mode 100644
index 000000000..0f900ff22
--- /dev/null
+++ b/plugins/argocd/README.md
@@ -0,0 +1,20 @@
+# Argo CD plugin
+
+This plugin adds completion for the [Argo CD](https://argoproj.github.io/cd/) CLI.
+
+To use it, add `argocd` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... argocd)
+```
+
+This plugin does not add any aliases.
+
+## Cache
+
+This plugin caches the completion script and is automatically updated asynchronously when the plugin is
+loaded, which is usually when you start up a new terminal emulator.
+
+The cache is stored at:
+
+- `$ZSH_CACHE/completions/_argocd` completions script