From 90d04346d59508c6c295a1f6ff559e7383ac2565 Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Wed, 16 Feb 2022 17:57:14 +0100 Subject: [PATCH] Add completion doc --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 02470f1..6bb45ad 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,27 @@ sudo make install PREFIX=/usr/local ``` +# Tips + +We strongly recommand to add the "completion" call to you SHELL using the common bashrc, or whatever the profile file you use. + +E.g. : + +``` +# bash in ~/.bashrc file +source <(katenary completion bash) +# if the documentation breaks a bit your completion: +source <(katenary completion bash --no-description) + +# zsh in ~/.zshrc +source <(helm completion zsh) + +# fish in ~/.config/fish/config.fish +katenary completion fish | source + +# powershell (as we don't provide any support on Windows yet, please avoid this...) +``` + # Usage ```bash