ca8c7bad1419b65ba4d64fbb838cad1f592cb539

Author
Brian Mitchell <bman4789@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

brew: add README (#7183)

Diff

 1diff --git a/plugins/brew/README.md b/plugins/brew/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..d50dfc21917150a31991c3a90fc51d7ccd78fe79
 4--- /dev/null
 5+++ b/plugins/brew/README.md
 6@@ -0,0 +1,19 @@
 7+# brew plugin
 8+
 9+The plugin adds several aliases for common [brew](https://brew.sh) commands.
10+
11+To use it, add `brew` to the plugins array of your zshrc file:
12+```
13+plugins=(... brew)
14+```
15+
16+## Aliases
17+
18+| Alias  | Command              | Description   |
19+|--------|----------------------|---------------|
20+| brewp  | `brew pin`           | Pin a specified formulae, preventing them from being upgraded when issuing the brew upgrade <formulae> command. |
21+| brews  | `brew list -1`       | List installed formulae, one entry per line, or the installed files for a given formulae. |
22+| brewsp | `brew list --pinned` | Show the versions of pinned formulae, or only the specified (pinned) formulae if formulae are given. |
23+| bubo   | `brew update && brew outdated` | Fetch the newest version of Homebrew and all formulae, then list outdated formulae. |
24+| bubc   | `brew upgrade && brew cleanup` | Upgrade outdated, unpinned brews (with existing install options), then removes stale lock files and outdated downloads for formulae and casks, and removes old versions of installed formulae. |
25+| bubo   | `bubo && bubc`       | Updates Homebrew, lists outdated formulae, upgrades oudated and unpinned formulae, and removes stale and outdated downloads and versions. |