9db3c9455377e15b8125e68a550e751bc5a3203f

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

Message

git-flow-avh: add README (#7360)

Diff

 1diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..0768d93ea8f6d1d2e8e5b855a190a81e1cb7c17a
 4--- /dev/null
 5+++ b/plugins/git-flow-avh/README.md
 6@@ -0,0 +1,19 @@
 7+# git-flow (AVH Edition) plugin
 8+
 9+This plugin adds completion for the [git-flow (AVH Edition)](https://github.com/petervanderdoes/gitflow-avh).
10+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/).
11+
12+To use it, add `git-flow-avh` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... git-flow-avh)
16+```
17+
18+## Requirements
19+
20+1. The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow)
21+   separately.
22+
23+2. You have to use zsh's git completion instead of the git project's git completion. This is typically
24+   done by default so you don't need to do anything else. If you installed git with Homebrew you
25+   might have to uninstall the git completion it's bundled with.
26diff --git a/plugins/git-flow-avh/git-flow-avh.plugin.zsh b/plugins/git-flow-avh/git-flow-avh.plugin.zsh
27index db8b5ff89a4441e2e32e2776823cb0ca8f05ac3f..860ca55c58ffc4200d587a3adbd8342f222eca6f 100644
28--- a/plugins/git-flow-avh/git-flow-avh.plugin.zsh
29+++ b/plugins/git-flow-avh/git-flow-avh.plugin.zsh
30@@ -1,25 +1,3 @@
31-#!zsh
32-#
33-# Installation
34-# ------------
35-#
36-# To achieve git-flow completion nirvana:
37-#
38-#  0. Update your zsh's git-completion module to the newest version.
39-#     From here: https://github.com/zsh-users/zsh/blob/master/Completion/Unix/Command/_git
40-#
41-#  1. Install this file. Either:
42-#
43-#     a. Place it in your .zshrc:
44-#
45-#     b. Or, copy it somewhere (e.g. ~/.git-flow-completion.zsh) and put the following line in
46-#        your .zshrc:
47-#
48-#            source ~/.git-flow-completion.zsh
49-#
50-#     c. Or, use this file as a oh-my-zsh plugin.
51-#
52-
53 _git-flow ()
54 {
55     local curcontext="$curcontext" state line