Update readme

This commit is contained in:
Eyal Posener 2020-04-04 12:47:08 +03:00
parent 1b58b8b755
commit bcff2ec278
1 changed files with 6 additions and 0 deletions

View File

@ -57,6 +57,12 @@ Supported shells:
- [x] zsh
- [x] fish
The installation of completion for a command line tool is done automatically by this library by
running the command line tool with the `COMP_INSTALL` environment variable set. Uninstalling the
completion is similarly done by the `COMP_UNINSTALL` environment variable.
For example, if a tool called `my-cli` uses this library, the completion can install by running
`COMP_INSTALL=1 my-cli`.
#### Usage
Add bash completion capabilities to any Go program. See [./example/command](./example/command).