summaryrefslogtreecommitdiff
path: root/plugins/kompose/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/kompose/README.md')
-rw-r--r--plugins/kompose/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/kompose/README.md b/plugins/kompose/README.md
new file mode 100644
index 000000000..e86d9263b
--- /dev/null
+++ b/plugins/kompose/README.md
@@ -0,0 +1,12 @@
+# kompose
+
+This plugin provides completion for [kompose](https://github.com/kubernetes/kompose),
+to migrate from docker compose to Kubernetes resource definitions.
+
+To use it, add `kompose` to the plugins array in your zshrc file.
+
+```
+plugins=(... kompose)
+```
+
+**Author:** [@kevinkirkup](https://github.com/kevinkirkup)