summaryrefslogtreecommitdiff
path: root/plugins/kamal/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/kamal/README.md')
-rw-r--r--plugins/kamal/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/kamal/README.md b/plugins/kamal/README.md
new file mode 100644
index 000000000..af5716826
--- /dev/null
+++ b/plugins/kamal/README.md
@@ -0,0 +1,16 @@
+# Kamal
+
+This plugin provides completion for [Kamal](https://kamal-deploy.org/) as well as some
+aliases for frequent Kamal commands.
+
+To use it, add kamal to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... kamal)
+```
+
+## Aliase
+
+| Alias | Command | Description |
+|-----------|----------------------------------|----------------------------------------------------------------------------------|
+| kad | `kamal deploy` | Deploy app to servers |