4c0b82b482be7fd36d5abceefe9901ea5ab3da9e

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

yarn: add README

Diff

 1diff --git a/plugins/yarn/README.md b/plugins/yarn/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..c4e6d6da542cbd7db3472ded527689fec06f042c
 4--- /dev/null
 5+++ b/plugins/yarn/README.md
 6@@ -0,0 +1,33 @@
 7+# Yarn plugin
 8+
 9+This plugin adds completion for the [Yarn package manager](https://yarnpkg.com/en/),
10+as well as some aliases for common Yarn commands.
11+
12+To use it, add `yarn` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... yarn)
16+```
17+
18+## Aliases
19+
20+| Alias | Command                                   | Description                                                 |
21+|-------|-------------------------------------------|-------------------------------------------------------------|
22+| y     | `yarn`                                    | The Yarn command                                            |
23+| ya    | `yarn add`                                | Install a package in dependencies (`package.json`)          |
24+| yad   | `yarn add --dev`                          | Install a package in devDependencies (`package.json`)       |
25+| yap   | `yarn add --peer`                         | Install a package in peerDependencies (`package.json`)      |
26+| yb    | `yarn build`                              | Run the build script defined in `package.json`              |
27+| ycc   | `yarn cache clean`                        | Clean yarn's global cache of packages                       |
28+| ygu   | `yarn global upgrade`                     | Upgrade packages installed globally to their latest version |
29+| yh    | `yarn help`                               | Show help for a yarn command                                |
30+| yin   | `yarn install`                            | Install dependencies defined in `package.json`              |
31+| yls   | `yarn list`                               | List installed packages                                     |
32+| yout  | `yarn outdated`                           | Check for outdated package dependencies                     |
33+| yrm   | `yarn remove`                             | Remove installed packages                                   |
34+| yrun  | `yarn run`                                | Run a defined package script                                |
35+| yst   | `yarn start`                              | Run the start script defined in `package.json`              |
36+| yt    | `yarn test`                               | Run the test script defined in `package.json`               |
37+| yuc   | `yarn global upgrade && yarn cache clean` | Upgrade global packages and clean yarn's global cache       |
38+| yui   | `yarn upgrade-interactive`                | Prompt for which outdated packages to upgrade               |
39+| yup   | `yarn upgrade`                            | Upgrade packages to their latest version                    |