66179bdab86227d924cd9e4c4b307be6465f09cc
- Author
- Marc Cornellà <marc.cornella@live.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
Fix git-flow README
- Fix "installation" information
- Add links to github project
- Transform list of aliases into table with descriptions
Diff
1diff --git a/plugins/git-flow/README.md b/plugins/git-flow/README.md
2index d4cde34aa916be272b32be6dca887aa7c23382f0..f37f418db4342bc00100b558b7dccefeb7069574 100644
3--- a/plugins/git-flow/README.md
4+++ b/plugins/git-flow/README.md
5@@ -1,36 +1,31 @@
6-# Git flow plugin installation
7+# Git-Flow plugin
8
9-```bash
10-git clone https://github.com/robbyrussell/oh-my-zsh.git
11+This plugin adds completion and aliases for the `git-flow` command. More information
12+at https://github.com/nvie/gitflow.
13
14-cp oh-my-zsh/plugins/git-flow/git-flow.plugin.zsh ~/.git-flow-completion.zsh
15-
16-vim ~/.zshrc
17+Enable git-flow plugin in your zshrc file:
18+```
19+plugins=(... git-flow)
20+```
21
22-# Which plugins would you like to load? (plugins can be found in ~/.oh-my-zsh/plugins/*)
23-# Custom plugins may be added to ~/.oh-my-zsh/custom/plugins/
24-# Example format: plugins=(rails git textmate ruby lighthouse)
25-# Add wisely, as too many plugins slow down shell startup.
26+## Aliases
27
28-plugins=(git git-flow)
29-
30-source ~/.git-flow-completion.zsh
31-```
32-## Your new git-flow alias
33+More information about `git-flow` commands:
34+https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
35
36-```bash
37-alias gfl='git flow'
38-alias gfli='git flow init'
39-alias gcd='git checkout develop'
40-alias gch='git checkout hotfix'
41-alias gcr='git checkout release'
42-alias gflf='git flow feature'
43-alias gflh='git flow hotfix'
44-alias gflr='git flow release'
45-alias gflfs='git flow feature start'
46-alias gflhs='git flow hotfix start'
47-alias gflrs='git flow release start'
48-alias gflff='git flow feature finish'
49-alias gflhf='git flow hotfix finish'
50-alias gflrf='git flow release finish'
51-```
52+| Alias | Command | Description |
53+|---------|---------------------------|----------------------------------------|
54+| `gfl` | `git flow` | Git-Flow command |
55+| `gfli` | `git flow init` | Initialize git-flow repository |
56+| `gcd` | `git checkout develop` | Check out develop branch |
57+| `gch` | `git checkout hotfix` | Check out hotfix branch |
58+| `gcr` | `git checkout release` | Check out release branch |
59+| `gflf` | `git flow feature` | List existing feature branches |
60+| `gflh` | `git flow hotfix` | List existing hotfix branches |
61+| `gflr` | `git flow release` | List existing release branches |
62+| `gflfs` | `git flow feature start` | Start a new feature: `gflfs <name>` |
63+| `gflhs` | `git flow hotfix start` | Start a new hotfix: `gflhs <version>` |
64+| `gflrs` | `git flow release start` | Start a new release: `gflrs <version>` |
65+| `gflff` | `git flow feature finish` | Finish feature: `gflff <name>` |
66+| `gflhf` | `git flow hotfix finish` | Finish hotfix: `gflhf <version>` |
67+| `gflrf` | `git flow release finish` | Finish release: `gflrf <version>` |