From bcff2ec278afb628a8dcb7ded65ad9d3450e4121 Mon Sep 17 00:00:00 2001 From: Eyal Posener Date: Sat, 4 Apr 2020 12:47:08 +0300 Subject: [PATCH] Update readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index fd49359..e4125b2 100644 --- a/README.md +++ b/README.md @@ -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).