add readme for grails plugin

2024-11-15 01:48:34 -07:00 · 2018-10-28 12:21:29 +01:00 · 2018-10-28 12:21:29 +01:00 · ac2ccb7535
commit ac2ccb7535
parent f96d18ca93
1 changed files with 15 additions and 0 deletions
--- a/plugins/grails/README.md
+++ b/plugins/grails/README.md
@ -0,0 +1,15 @@
+# Grails plugin
+
+Adds tab-completion of Grails script names to the command line use of grails.
+Looks for scripts in the following paths:
+
+- `$GRAILS_HOME/scripts`
+- `~/.grails/scripts`
+- `./scripts`
+- `./plugins/*/scripts`
+
+To use it, add `grails` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... grails)
+```