From d0ea3f22b1099ce98e0fc02b6074d862478ae81a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com>
Date: Sat, 2 Jul 2016 11:59:04 +0200
Subject: [PATCH] Add more information to the README

---
 plugins/getgb/README.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/plugins/getgb/README.md b/plugins/getgb/README.md
index b477b0f4..88881cb2 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.