ea7b886f701316199cf90761a6e9a2a27659b544
- Author
- Marc Cornellà <marc.cornella@live.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
composer: add README (#7291)
Diff
1diff --git a/plugins/composer/README.md b/plugins/composer/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..2b4bae5790d70ba2649eab9ba188480587e519b3
4--- /dev/null
5+++ b/plugins/composer/README.md
6@@ -0,0 +1,29 @@
7+# composer
8+
9+This plugin provides completion for [composer](https://getcomposer.org/), as well as aliases
10+for frequent composer commands. It also adds Composer's global binaries to the PATH, using
11+Composer if available.
12+
13+To use it add `composer` to the plugins array in your zshrc file.
14+
15+```zsh
16+plugins=(... composer)
17+```
18+
19+## Aliases
20+
21+| Alias | Command | Description |
22+| ------ | -------------------------------------------- | -------------------------------------------------------------------------------------- |
23+| `c` | composer | Starts composer |
24+| `csu` | composer self-update | Updates composer to the latest version |
25+| `cu` | composer update | Updates composer dependencies and `composer.lock` file |
26+| `cr` | composer require | Adds new packages to `composer.json` |
27+| `crm` | composer remove | Removes packages from `composer.json` |
28+| `ci` | composer install | Resolves and installs dependencies from `composer.json` |
29+| `ccp` | composer create-project | Create new project from an existing package |
30+| `cdu` | composer dump-autoload | Updates the autoloader |
31+| `cdo` | composer dump-autoload --optimize-autoloader | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) |
32+| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory |
33+| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory |
34+| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory |
35+| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory |