summaryrefslogtreecommitdiff
path: root/plugins/git-flow-avh
diff options
context:
space:
mode:
authorMarco Zühlke <mzuehlke@gmail.com>2018-10-28 11:36:54 +0100
committerMarco Zühlke <mzuehlke@gmail.com>2018-10-28 11:36:54 +0100
commitc4bdb83f07e8efee940292a42dd286a6263848ca (patch)
tree81c1132623dd09f5e5143253a1942136211945e4 /plugins/git-flow-avh
parentf96d18ca935f9b9bd6f1c51cb5c821a0b18e9601 (diff)
downloadzsh-c4bdb83f07e8efee940292a42dd286a6263848ca.tar.gz
zsh-c4bdb83f07e8efee940292a42dd286a6263848ca.tar.bz2
zsh-c4bdb83f07e8efee940292a42dd286a6263848ca.zip
add readme fot git-flow-avh
Diffstat (limited to 'plugins/git-flow-avh')
-rw-r--r--plugins/git-flow-avh/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md
new file mode 100644
index 000000000..340ed80d1
--- /dev/null
+++ b/plugins/git-flow-avh/README.md
@@ -0,0 +1,12 @@
+# git-flow (AVH Edition) plugin
+
+This plugin adds completion for the [git-flow (AVH Edition)](https://github.com/petervanderdoes/gitflow-avh).
+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/).
+
+The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow) separately.
+
+To use it, add `git-flow-avh` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-flow-avh)
+```