8f777f30bbb97f27b855bad5585619da499ea7e1

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

add git completion requirements notice

Diff

 1diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md
 2index 340ed80d1f3b333a1c5bc71842ed9d8751778afc..0768d93ea8f6d1d2e8e5b855a190a81e1cb7c17a 100644
 3--- a/plugins/git-flow-avh/README.md
 4+++ b/plugins/git-flow-avh/README.md
 5@@ -3,10 +3,17 @@
 6 This plugin adds completion for the [git-flow (AVH Edition)](https://github.com/petervanderdoes/gitflow-avh).
 7 The AVH Edition of the git extensions that provides high-level repository operations for [Vincent Driessen's branching model](https://nvie.com/posts/a-successful-git-branching-model/).
 8 
 9-The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow) separately.
10-
11 To use it, add `git-flow-avh` to the plugins array in your zshrc file:
12 
13 ```zsh
14 plugins=(... git-flow-avh)
15 ```
16+
17+## Requirements
18+
19+1. The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow)
20+   separately.
21+
22+2. You have to use zsh's git completion instead of the git project's git completion. This is typically
23+   done by default so you don't need to do anything else. If you installed git with Homebrew you
24+   might have to uninstall the git completion it's bundled with.