d56cec1e8df19f67f665ff790b2fe2fb9ed59b50

Author
Sagar Patil <sagar010797@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

Composer Readme added

Diff

 1diff --git a/plugins/composer/README.md b/plugins/composer/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b0c38cf3912a7815a0ed5d64764c17bb6bb58396
 4--- /dev/null
 5+++ b/plugins/composer/README.md
 6@@ -0,0 +1,31 @@
 7+# composer
 8+
 9+This plugin provides completion for [composer](https://getcomposer.org/),
10+as well as aliases for frequent composer commands.
11+
12+To use it add `composer` to the plugins array in your zshrc file.
13+
14+```zsh
15+plugins=(... composer)
16+```
17+
18+## Aliases
19+
20+| Alias  | Command                                       | Description                                                                                                                     |
21+| ------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
22+| `c`    | composer                                      | Start composer, get help with composer commands                                                                                 |
23+| `csu`  | composer self-update                          | Update composer to the latest version                                                                                           |
24+| `cu`   | composer update                               | Update composer dependencies and `composer.lock` file                                                                           |
25+| `cr`   | composer require                              | Adds new packages to the  `composer.json` file from current directory                                                           |
26+| `crm`  | composer remove                               | Removes packages from the `composer.json` file from the current directory                                                       |
27+| `ci`   | composer install                              | Reads the `composer.json` file from the current directory, resolves the dependencies, and installs them into `vendor`           |
28+| `ccp`  | composer create-project                       | Create new project from an existing package                                                                                     |
29+| `cdu`  | composer dump-autoload                        | Update the autoloader due to new classes in a classmap package without having to go through an install or update                |
30+| `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  |
31+| `cgu`  | composer global update                        | Allows update command to run on COMPOSER_HOME directory                                                                         |                                 
32+| `cgr`  | composer global require                       | Allows require command to run on COMPOSER_HOME directory                                                                        |
33+| `cgrm` | composer global remove                        | Allows remove command to run on COMPOSER_HOME directory                                                                         |
34+| `cget` | `curl -s https://getcomposer.org/installer`   | Installs composer in the current directory                                                                                      |
35+
36+
37+The plugin adds Composer's global binaries to PATH, using Composer if available.