summaryrefslogtreecommitdiff
path: root/plugins/capistrano/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/capistrano/README.md')
-rw-r--r--plugins/capistrano/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/capistrano/README.md b/plugins/capistrano/README.md
new file mode 100644
index 000000000..335b794fa
--- /dev/null
+++ b/plugins/capistrano/README.md
@@ -0,0 +1,14 @@
+# Capistrano
+
+This plugin provides completion for [Capistrano](https://capistranorb.com/).
+
+To use it add capistrano to the plugins array in your zshrc file.
+
+```bash
+plugins=(... capistrano)
+```
+
+For a working completion use the `capit` command instead of `cap`, because cap is a
+[reserved word in zsh](http://zsh.sourceforge.net/Doc/Release/Zsh-Modules.html#The-zsh_002fcap-Module).
+
+`capit` automatically runs cap with bundler if a Gemfile is found.