dolysis
/
ohmyzsh
3
0
Fork 0
Code Issues Pull Requests Releases Activity

Add more information to the README

This commit is contained in:
Marc Cornellà 2016-07-02 11:59:04 +02:00
parent 57a689ffd5
commit d0ea3f22b1
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
plugins/getgb/README.md
View File

@ -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.