summaryrefslogtreecommitdiff
path: root/plugins/git-extras
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/git-extras
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
Diffstat (limited to 'plugins/git-extras')
-rw-r--r--plugins/git-extras/README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/plugins/git-extras/README.md b/plugins/git-extras/README.md
index 987f0d800..2adc9d477 100644
--- a/plugins/git-extras/README.md
+++ b/plugins/git-extras/README.md
@@ -2,10 +2,16 @@
This plugin provides completion definitions for some of the commands defined by [git-extras](https://github.com/tj/git-extras).
-## Setup notes
+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
-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.
+**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.~~