diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2016-07-02 11:59:04 +0200 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2016-07-03 23:20:30 +0200 |
| commit | d0ea3f22b1099ce98e0fc02b6074d862478ae81a (patch) | |
| tree | 5386cd4327c6844324ed33c5df20b889b3456acd /plugins | |
| parent | 57a689ffd5dd54852afeea38e5c401d5a29b4493 (diff) | |
| download | zsh-d0ea3f22b1099ce98e0fc02b6074d862478ae81a.tar.gz zsh-d0ea3f22b1099ce98e0fc02b6074d862478ae81a.tar.bz2 zsh-d0ea3f22b1099ce98e0fc02b6074d862478ae81a.zip | |
Add more information to the README
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/getgb/README.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/plugins/getgb/README.md b/plugins/getgb/README.md index b477b0f4c..88881cb28 100644 --- a/plugins/getgb/README.md +++ b/plugins/getgb/README.md @@ -1,10 +1,21 @@ -# *gb* plugin +# `gb` plugin -- aims to support completion for all *gb* commands -- also supports completion for *gb* plugins such as *vendor* +> A project based build tool for the Go programming language. -See http://getgb.io for the full *gb* documentation +See https://getgb.io for the full `gb` documentation + +* * * * + +- Adds completion support for all `gb` commands. +- Also supports completion for the [`gb-vendor` plugin](https://godoc.org/github.com/constabulary/gb/cmd/gb-vendor). + +To use it, add `getgb` to your plugins array: +```sh +plugins=(... getgb) +``` ## Caveats -- The *git* plugin installs an alias *gb* that usually conflicts with the *gb* program +The `git` plugin defines an alias `gb` that usually conflicts with the `gb` program. +If you're having trouble with it, remove it by adding `unalias gb` at the end of your +zshrc file. |