c4bdb83f07e8efee940292a42dd286a6263848ca
- Author
- Marco Zühlke <mzuehlke@gmail.com>
- Committer
- Marco Zühlke <mzuehlke@gmail.com>
- Date
Message
add readme fot git-flow-avh
Diff
1diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..340ed80d1f3b333a1c5bc71842ed9d8751778afc
4--- /dev/null
5+++ b/plugins/git-flow-avh/README.md
6@@ -0,0 +1,12 @@
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+The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow) separately.
13+
14+To use it, add `git-flow-avh` to the plugins array in your zshrc file:
15+
16+```zsh
17+plugins=(... git-flow-avh)
18+```