From 1b58b8b755320649a51707ac927fe46164fc3896 Mon Sep 17 00:00:00 2001 From: Eyal Posener Date: Sat, 4 Apr 2020 12:44:12 +0300 Subject: [PATCH] Add installation instructions Related to #120 --- doc.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc.go b/doc.go index 63775dc..51ce8ba 100644 --- 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.