summaryrefslogtreecommitdiff
path: root/plugins/git-flow
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/git-flow')
-rw-r--r--plugins/git-flow/README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/plugins/git-flow/README.md b/plugins/git-flow/README.md
index 5d8049e3b..9c25dec83 100644
--- a/plugins/git-flow/README.md
+++ b/plugins/git-flow/README.md
@@ -1,18 +1,15 @@
# Git-Flow plugin
-This plugin adds completion and aliases for the `git-flow` command. More information
-at https://github.com/nvie/gitflow.
+This plugin adds completion and aliases for the [`git-flow` command](https://github.com/nvie/gitflow).
-Enable git-flow plugin in your zshrc file:
-```
+To use it, add `git-flow` to the plugins array in your zshrc file:
+
+```zsh
plugins=(... git-flow)
```
## Aliases
-More information about `git-flow` commands:
-https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
-
| Alias | Command | Description |
|---------|----------------------------|----------------------------------------|
| `gfl` | `git flow` | Git-Flow command |
@@ -30,3 +27,5 @@ https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
| `gflfp` | `git flow feature publish` | Publish feature: `gflfp <name>` |
| `gflhf` | `git flow hotfix finish` | Finish hotfix: `gflhf <version>` |
| `gflrf` | `git flow release finish` | Finish release: `gflrf <version>` |
+
+[More information about `git-flow` commands](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments).