diff options
| author | Eyal Posener <[email protected]> | 2020-04-04 12:47:08 +0300 |
|---|---|---|
| committer | Eyal Posener <[email protected]> | 2020-04-04 12:47:08 +0300 |
| commit | bcff2ec278afb628a8dcb7ded65ad9d3450e4121 (patch) | |
| tree | 6084521015a6e7fa42b7c6d5c538e3bb9a2bd158 | |
| parent | 1b58b8b755320649a51707ac927fe46164fc3896 (diff) | |
Update readme
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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). |