omz

1 files changed, 17 insertions, 0 deletions

diff --git a/home/.oh-my-zsh/plugins/git-extras/README.md b/home/.oh-my-zsh/plugins/git-extras/README.md
new file mode 100644
index 0000000..7eb53fc
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/git-extras/README.md
@@ -0,0 +1,17 @@
+# git-extras
+
+This plugin provides completion definitions for some of the commands defined by [git-extras](https://github.com/tj/git-extras), which must already be installed.
+
+To use it, add `git-extras` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-extras)
+```
+
+## Setup notes
+
+The completions work by augmenting the `_git` completion provided by `zsh`. This only works with the `zsh`-provided `_git`, not the `_git` provided by `git` itself. If you have both `zsh` and `git` installed, you need to make sure that the `zsh`-provided `_git` takes precedence.
+
+### OS X Homebrew Setup
+
+**NOTE:** this no longer works on current Homebrew distributions of git. ~~On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands.~~