d0ea3f22b1099ce98e0fc02b6074d862478ae81a

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Add more information to the README

Diff

 1diff --git a/plugins/getgb/README.md b/plugins/getgb/README.md
 2index b477b0f4ccd8cd15823219c8bf0a3b0cc5bafc70..88881cb28d3aec1481ca56b04f9e345fe4d00397 100644
 3--- a/plugins/getgb/README.md
 4+++ b/plugins/getgb/README.md
 5@@ -1,10 +1,21 @@
 6-# *gb* plugin
 7+# `gb` plugin
 8 
 9-- aims to support completion for all *gb* commands
10-- also supports completion for *gb* plugins such as *vendor*
11+> A project based build tool for the Go programming language.
12 
13-See http://getgb.io for the full *gb* documentation
14+See https://getgb.io for the full `gb` documentation
15+
16+* * * *
17+
18+- Adds completion support for all `gb` commands.
19+- Also supports completion for the [`gb-vendor` plugin](https://godoc.org/github.com/constabulary/gb/cmd/gb-vendor).
20+
21+To use it, add `getgb` to your plugins array:
22+```sh
23+plugins=(... getgb)
24+```
25 
26 ## Caveats
27 
28-- The *git* plugin installs an alias *gb* that usually conflicts with the *gb* program
29+The `git` plugin defines an alias `gb` that usually conflicts with the `gb` program.
30+If you're having trouble with it, remove it by adding `unalias gb` at the end of your
31+zshrc file.