summaryrefslogtreecommitdiff
path: root/plugins/git-extras/README.md
diff options
context:
space:
mode:
authorRobby Russell <robby@planetargon.com>2015-10-05 13:46:26 -0700
committerRobby Russell <robby@planetargon.com>2015-10-05 13:46:26 -0700
commitf3fa41834d9c954ee2d352c6c5b60d72f7a93593 (patch)
tree409c88915437e753a9ed16de6c49b376081dd362 /plugins/git-extras/README.md
parentd26549b7ecb93665148e37b18741ace6d0b8141a (diff)
parent62c86f5c7529691c1f7cca14ba8f06b449d03fe9 (diff)
downloadzsh-f3fa41834d9c954ee2d352c6c5b60d72f7a93593.tar.gz
zsh-f3fa41834d9c954ee2d352c6c5b60d72f7a93593.tar.bz2
zsh-f3fa41834d9c954ee2d352c6c5b60d72f7a93593.zip
Merge branch 'master' of github.com:robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/git-extras/README.md')
-rw-r--r--plugins/git-extras/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/plugins/git-extras/README.md b/plugins/git-extras/README.md
new file mode 100644
index 000000000..8f12e297e
--- /dev/null
+++ b/plugins/git-extras/README.md
@@ -0,0 +1,11 @@
+# git-extras
+
+This plugin provides completion definitions for some of the commands defined by [git-extras](http://github.com/tj/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
+
+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.