a6d40b8f8beec16f582b0a4404cf1b6c8a848689

Author
Sergey Lysenko <soulwish.ls@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

laravel: add README (#7222)

Diff

 1diff --git a/plugins/laravel/README.md b/plugins/laravel/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..067c1e9fb3b72282bf490768e57400fb9248171c
 4--- /dev/null
 5+++ b/plugins/laravel/README.md
 6@@ -0,0 +1,19 @@
 7+# Laravel plugin
 8+
 9+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.
10+
11+**NOTE:** completion might not work for recent Laravel versions since it hasn't been updated since 2012.
12+In that case, check out plugins `laravel4` and `laravel5`.
13+
14+To use it, add `laravel` to the plugins array in your zshrc file:
15+
16+```zsh
17+plugins=(... laravel)
18+```
19+
20+## Aliases
21+
22+| Alias     | Command                  | Description          |
23+|-----------|--------------------------|----------------------|
24+| artisan   | `php artisan`            | Main Artisan command |
25+| bob       | `php artisan bob::build` | Main Bob command     |