From dc0a884ea7b4298861cb081a4b76c9f0b42c7ebe Mon Sep 17 00:00:00 2001
From: Marc Cornellà <marc.cornella@live.com>
Date: Sun, 3 Jul 2016 23:29:00 +0200
Subject: Rename getgb plugin to gb

---
 plugins/gb/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 plugins/gb/README.md

(limited to 'plugins/gb/README.md')

diff --git a/plugins/gb/README.md b/plugins/gb/README.md
new file mode 100644
index 000000000..822c29aaa
--- /dev/null
+++ b/plugins/gb/README.md
@@ -0,0 +1,21 @@
+# `gb` plugin
+
+> A project based build tool for the Go programming language.
+
+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 `gb` to your plugins array:
+```sh
+plugins=(... gb)
+```
+
+## Caveats
+
+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.
-- 
cgit v1.2.3-70-g09d2