diff --git a/plugins/adonis/README.md b/plugins/adonis/README.md index 7d8e70448..d8bc35cac 100644 --- a/plugins/adonis/README.md +++ b/plugins/adonis/README.md @@ -1,9 +1,56 @@ # Adonis -This plugin provides completion for [AdonisJs](https://adonisjs.com/). +This plugin provides completion and aliases for [AdonisJs](https://adonisjs.com/). To use it add adonis to the plugins array in your zshrc file. ```bash plugins=(... adonis) -``` \ No newline at end of file +``` + +## Development + +| Alias | Description | +|:-:|:-:| +| `ads` | `adonis serve --dev` | +| `adrepl` | `adonis repl` | +| `adinstall` | `adonis install` | +| `adt` | `adonis test` | +| `adaddon` | `adonis addon` | + +## Migration + +| Alias | Description | +|:-:|:-:| +| `admt` | `adonis migration:run` | +| `admtrt` | `adonis migration:reset` | +| `admtrf` | `adonis migration:refresh` | +| `admtrfs` | `adonis migration:refresh --seed` | +| `admtr` | `adonis migration:rollback` | +| `admts` | `adonis migration:status` | + +## Makers + +| Alias | Description | +|:-:|:-:| +| `admcm` | `adonis make:command` | +| `admc` | `adonis make:controller` | +| `admh` | `adonis make:ehandler` | +| `adme` | `adonis make:exception` | +| `admhk` | `adonis make:hook` | +| `adml` | `adonis make:listener` | +| `admmw` | `adonis make:middleware` | +| `admmt` | `adonis make:migration` | +| `admm` | `adonis make:model` | +| `admp` | `adonis make:provider` | +| `adms` | `adonis make:seed` | +| `admt` | `adonis make:test` | +| `admtr` | `adonis make:trait` | +| `admv` | `adonis make:validator` | +| `admvw` | `adonis make:view` | + +## Route + +| Alias | Description | +|:-:|:-:| +| `adroute` | `adonis route:list` |