f1250cfbce4dc08b1b4d147ff533fad0ca64d5e0

Author
Marco Zühlke <mzuehlke@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

git-hubflow: add README (#7361)

Diff

 1diff --git a/plugins/git-hubflow/README.md b/plugins/git-hubflow/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..dada60d78227877abaec6b1d1069d6940754c88d
 4--- /dev/null
 5+++ b/plugins/git-hubflow/README.md
 6@@ -0,0 +1,24 @@
 7+# git-hubflow plugin
 8+
 9+This plugin adds completion for [HubFlow](https://datasift.github.io/gitflow/) (GitFlow for GitHub), as well as some
10+aliases for common commands. HubFlow is a git extension to make it easy to use GitFlow with GitHub. Based on the
11+original gitflow extension for git.
12+
13+The hubflow tool has to be [installed](https://github.com/datasift/gitflow#installation) separately.
14+
15+To use it, add `git-hubflow` to the plugins array in your zshrc file:
16+
17+```zsh
18+plugins=(... git-hubflow)
19+```
20+
21+## Aliases
22+
23+| Alias | Command          | Description                                                      |
24+|-------|------------------|------------------------------------------------------------------|
25+| ghf   | `git hf`         | Print command overview                                           |
26+| ghff  | `git hf feature` | Manage your feature branches                                     |
27+| ghfr  | `git hf release` | Manage your release branches                                     |
28+| ghfh  | `git hf hotfix`  | Manage your hotfix branches                                      |
29+| ghfs  | `git hf support` | Manage your support branches                                     |
30+| ghfu  | `git hf update`  | Pull upstream changes down into your master and develop branches |
31diff --git a/plugins/git-hubflow/git-hubflow.plugin.zsh b/plugins/git-hubflow/git-hubflow.plugin.zsh
32index 8d968229ffd636380058f7641617c2b99ec1cd82..05479f7e6501f5661d2d001ec4a541931d37bffd 100644
33--- a/plugins/git-hubflow/git-hubflow.plugin.zsh
34+++ b/plugins/git-hubflow/git-hubflow.plugin.zsh
35@@ -1,25 +1,3 @@
36-#!zsh
37-#
38-# Installation
39-# ------------
40-#
41-# To achieve git-hubflow completion nirvana:
42-#
43-#  0. Update your zsh's git-completion module to the newest version.
44-#     From here: https://github.com/zsh-users/zsh/blob/master/Completion/Unix/Command/_git
45-#
46-#  1. Install this file. Either:
47-#
48-#     a. Place it in your .zshrc:
49-#
50-#     b. Or, copy it somewhere (e.g. ~/.git-hubflow-completion.zsh) and put the following line in
51-#        your .zshrc:
52-#
53-#            source ~/.git-hubflow-completion.zsh
54-#
55-#     c. Or, use this file as an oh-my-zsh plugin.
56-#
57-
58 alias ghf='git hf'
59 alias ghff='git hf feature'
60 alias ghfr='git hf release'