Add steps to enable shell completion to README

We get this for free with click. See https://click.palletsprojects.com/en/8.0.x/shell-completion/
mikepqr · Aug 22, 2021 · cb90311 · cb90311
1 parent 943765b
commit cb90311
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -32,6 +32,17 @@ See `ambient --help` for more.
 `backfill` does not overwrite files. You must manually delete them if
 you want fresh copies for some reason. `today` and `yesterday` overwrite.
 
+### Shell completion
+
+You can optionally enable shell completion by running the appropriate command
+for your shell:
+
+```bash
+eval "$(_AMBIENT_COMPLETE=bash_source ambient)" >> ~/.bashrc # bash
+eval "$(_AMBIENT_COMPLETE=zsh_source ambient)" >> ~/.zshrc  # zsh
+_AMBIENT_COMPLETE=fish_source foo-bar > ~/.config/fish/completions/ambient.fish  # fish
+```
+
 ## Automation with Github Actions
 
 1. Create a new repository, run `ambient backfill` then check everything in

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = ambient-archiver
-version = 0.1.3
+version = 0.1.4
 description = Archive your data from ambientweather.net
 long_description = file: README.md
 long_description_content_type = text/markdown