summaryrefslogtreecommitdiff
path: root/plugins/gb/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-07-05 11:22:48 +0200
committerGitHub <noreply@github.com>2016-07-05 11:22:48 +0200
commit644bc641ad48c74c88631d79d48ec9b6f3f5a3e5 (patch)
tree4ed74d79014d99eb37233f7b2fbc51157bb9cee4 /plugins/gb/README.md
parent7fabc8bca41d4ff7090325116a85513dac852236 (diff)
parentdc0a884ea7b4298861cb081a4b76c9f0b42c7ebe (diff)
downloadzsh-644bc641ad48c74c88631d79d48ec9b6f3f5a3e5.tar.gz
zsh-644bc641ad48c74c88631d79d48ec9b6f3f5a3e5.tar.bz2
zsh-644bc641ad48c74c88631d79d48ec9b6f3f5a3e5.zip
Merge pull request #5207 from mcornella/gb-plugin
Repost of #5176: add gb plugin
Diffstat (limited to 'plugins/gb/README.md')
-rw-r--r--plugins/gb/README.md21
1 files changed, 21 insertions, 0 deletions
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.