homebrew: Add a wrapper function for the brew(1) command

[ax-zsh.git] / plugins / homebrew / README.md

diff --git a/plugins/homebrew/README.md b/plugins/homebrew/README.md
index 201b8dd6f5d1285b86bfe75c6b84be54383d2bc3..c64c961e5bdbd8a65e89ddd33d2974944f493212 100644 (file)
--- a/plugins/homebrew/README.md
+++ b/plugins/homebrew/README.md
@@ -3,3 +3,13 @@
 Setup "Homebrew" ("The missing package manager for OS X", http://brew.sh):
 
 - Enable ZSH completions installed by Homebrew formulae.
+- Install a `brew` wrapper function.
+
+This wrapper function for the `brew`(1) command does the following:
+
+- Detect the location of the "real" brew(1) command.
+- Change user and group when the Homebrew installation is owned by a different
+  user (to preserve sane file permissions).
+- Set a relaxed umask(1) so that other users can use software installed by
+  Homebrew.
+- Call the "real" `brew`(1) command.