summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/grails/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/grails/README.md b/plugins/grails/README.md
new file mode 100644
index 000000000..6bf2ac1e6
--- /dev/null
+++ b/plugins/grails/README.md
@@ -0,0 +1,16 @@
+# Grails plugin
+
+Adds tab-completion of [Grails](https://grails.org/) script names to the command line use of grails.
+
+To use it, add `grails` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... grails)
+```
+
+It looks for scripts in the following paths:
+
+- `$GRAILS_HOME/scripts`
+- `~/.grails/scripts`
+- `./scripts`
+- `./plugins/*/scripts`