diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2018-10-17 20:34:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-17 20:34:58 +0200 |
| commit | f8ca1464b9d1792b2a6bc227c152197538b5ae9d (patch) | |
| tree | 804197293f937b8d35774fc58de05e18e8e28e4c | |
| parent | d56cec1e8df19f67f665ff790b2fe2fb9ed59b50 (diff) | |
| download | zsh-f8ca1464b9d1792b2a6bc227c152197538b5ae9d.tar.gz zsh-f8ca1464b9d1792b2a6bc227c152197538b5ae9d.tar.bz2 zsh-f8ca1464b9d1792b2a6bc227c152197538b5ae9d.zip | |
reword
| -rw-r--r-- | plugins/composer/README.md | 38 |
1 files changed, 18 insertions, 20 deletions
diff --git a/plugins/composer/README.md b/plugins/composer/README.md index b0c38cf39..2b4bae579 100644 --- a/plugins/composer/README.md +++ b/plugins/composer/README.md @@ -1,7 +1,8 @@ # composer -This plugin provides completion for [composer](https://getcomposer.org/), -as well as aliases for frequent composer commands. +This plugin provides completion for [composer](https://getcomposer.org/), as well as aliases +for frequent composer commands. It also adds Composer's global binaries to the PATH, using +Composer if available. To use it add `composer` to the plugins array in your zshrc file. @@ -11,21 +12,18 @@ plugins=(... composer) ## Aliases -| Alias | Command | Description | -| ------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `c` | composer | Start composer, get help with composer commands | -| `csu` | composer self-update | Update composer to the latest version | -| `cu` | composer update | Update composer dependencies and `composer.lock` file | -| `cr` | composer require | Adds new packages to the `composer.json` file from current directory | -| `crm` | composer remove | Removes packages from the `composer.json` file from the current directory | -| `ci` | composer install | Reads the `composer.json` file from the current directory, resolves the dependencies, and installs them into `vendor` | -| `ccp` | composer create-project | Create new project from an existing package | -| `cdu` | composer dump-autoload | Update the autoloader due to new classes in a classmap package without having to go through an install or update | -| `cdo` | composer dump-autoload --optimize-autoloader | Convert PSR-0/4 autoloading to classmap to get a faster autoloader. Recommended especially for production, set `no` by default | -| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory | -| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory | -| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory | -| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory | - - -The plugin adds Composer's global binaries to PATH, using Composer if available. +| Alias | Command | Description | +| ------ | -------------------------------------------- | -------------------------------------------------------------------------------------- | +| `c` | composer | Starts composer | +| `csu` | composer self-update | Updates composer to the latest version | +| `cu` | composer update | Updates composer dependencies and `composer.lock` file | +| `cr` | composer require | Adds new packages to `composer.json` | +| `crm` | composer remove | Removes packages from `composer.json` | +| `ci` | composer install | Resolves and installs dependencies from `composer.json` | +| `ccp` | composer create-project | Create new project from an existing package | +| `cdu` | composer dump-autoload | Updates the autoloader | +| `cdo` | composer dump-autoload --optimize-autoloader | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) | +| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory | +| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory | +| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory | +| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory | |