summaryrefslogtreecommitdiff
path: root/plugins/laravel
diff options
context:
space:
mode:
authorSergey Lysenko <soulwish.ls@gmail.com>2018-10-04 14:23:07 +0300
committerMarc Cornellà <marc.cornella@live.com>2018-10-04 13:23:07 +0200
commita6d40b8f8beec16f582b0a4404cf1b6c8a848689 (patch)
tree656ca9973a74e3fa2f7215e56bb5e090b450e85d /plugins/laravel
parentd05bf3962bc230f2013c7f7c55f764d98afa2344 (diff)
downloadzsh-a6d40b8f8beec16f582b0a4404cf1b6c8a848689.tar.gz
zsh-a6d40b8f8beec16f582b0a4404cf1b6c8a848689.tar.bz2
zsh-a6d40b8f8beec16f582b0a4404cf1b6c8a848689.zip
laravel: add README (#7222)
Diffstat (limited to 'plugins/laravel')
-rw-r--r--plugins/laravel/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/laravel/README.md b/plugins/laravel/README.md
new file mode 100644
index 000000000..067c1e9fb
--- /dev/null
+++ b/plugins/laravel/README.md
@@ -0,0 +1,19 @@
+# Laravel plugin
+
+This plugin adds aliases and autocompletion for Laravel [Artisan](https://laravel.com/docs/artisan) and [Bob](http://daylerees.github.io/laravel-bob/) command-line interfaces.
+
+**NOTE:** completion might not work for recent Laravel versions since it hasn't been updated since 2012.
+In that case, check out plugins `laravel4` and `laravel5`.
+
+To use it, add `laravel` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... laravel)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-----------|--------------------------|----------------------|
+| artisan | `php artisan` | Main Artisan command |
+| bob | `php artisan bob::build` | Main Bob command |