From 52a7191d1fd291650b5ed976032c65845e8a44df Mon Sep 17 00:00:00 2001 From: Ivan Habunek Date: Tue, 26 Mar 2024 10:13:22 +0100 Subject: [PATCH] Add docs and changelog --- README.md | 2 +- changelog.yaml | 7 +++++++ docs/installation.md | 2 +- docs/shell_completion.md | 31 +++++++++++++++++++++++++++++++ 4 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 docs/shell_completion.md diff --git a/README.md b/README.md index 33f477b..6bee5a4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Resources Requirements ------------ -* Python 3.7 or later +* Python 3.8 or later * [ffmpeg](https://ffmpeg.org/download.html), installed and on the system path Quick start diff --git a/changelog.yaml b/changelog.yaml index 31a67dd..26ea4e2 100644 --- a/changelog.yaml +++ b/changelog.yaml @@ -1,3 +1,10 @@ +3.0.0: + date: TBA + changes: + - "BREAKING: Requires python 3.8 or later" + - "Migrated to click lib for cli parsing" + - "Add shell auto completion" + 2.1.4: date: 2024-01-06 changes: diff --git a/docs/installation.md b/docs/installation.md index d7c78dd..ba0c88d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,6 @@ # Installation -twitch-dl requires **Python 3.7** or later. +twitch-dl requires **Python 3.8** or later. ## Prerequisite: FFmpeg diff --git a/docs/shell_completion.md b/docs/shell_completion.md new file mode 100644 index 0000000..1544675 --- /dev/null +++ b/docs/shell_completion.md @@ -0,0 +1,31 @@ +# Shell completion + +> Introduced in twitch-dl 3.0.0 + +twitch-dl uses [Click shell completion](https://click.palletsprojects.com/en/8.1.x/shell-completion/) which works on Bash, Fish and Zsh. + +To enable completion, twitch-dl must be [installed](./installation.html) as a command and available by ivoking `twitch-dl`. Then follow the instructions for your shell. + +**Bash** + +Add to `~/.bashrc`: + +``` +eval "$(_TWITCH_DL_COMPLETE=bash_source twitch-dl)" +``` + +**Fish** + +Add to `~/.config/fish/completions/twitch-dl.fish`: + +``` +_TWITCH_DL_COMPLETE=fish_source twitch-dl | source +``` + +**Zsh** + +Add to `~/.zshrc`: + +``` +eval "$(_TWITCH_DL_COMPLETE=zsh_source twitch-dl)" +```