summaryrefslogtreecommitdiff
path: root/plugins/eecms/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/eecms/README.md')
-rw-r--r--plugins/eecms/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/plugins/eecms/README.md b/plugins/eecms/README.md
new file mode 100644
index 000000000..c53835521
--- /dev/null
+++ b/plugins/eecms/README.md
@@ -0,0 +1,11 @@
+# eecms plugin
+
+This plugin adds auto-completion of console commands for [`eecms`](https://github.com/ExpressionEngine/ExpressionEngine).
+
+To use it, add `eecms` to the plugins array of your `.zshrc` file:
+```
+plugins=(... eecms)
+```
+
+It also adds the alias `eecms` which finds the eecms file in the current project
+and runs it with php.