Add installation instructions

Related to #120
2020-04-04 12:44:12 +03:00 · 2020-04-04 12:44:12 +03:00 · 1b58b8b755
parent bdd345f079
commit 1b58b8b755
1 changed files with 6 additions and 0 deletions
--- a/doc.go
+++ b/doc.go
@ -48,6 +48,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.