From da20e84513b414b19e3d9d45cb97f7400404fa4a Mon Sep 17 00:00:00 2001 From: Kharec Date: Wed, 18 Feb 2026 04:02:20 +0100 Subject: [PATCH] docs: update readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9a81576..aa2e617 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A terminal-based user interface (TUI) client for [Audible](https://www.audible.fr/), written in Python 3. -Currently, the only available theme is Catppuccin Mocha, following their [style guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md), as it's my preferred theme across most of my tools. +The interface currently ships with a single built-in theme. ## Requirements @@ -36,9 +36,9 @@ auditui --version All set, run `auditui configure` to set up authentication, and then `auditui` to start the TUI. -### Workaround for Python 3.13 linux distribution +### Workaround for Python 3.13 Linux distributions -On some Linux distributions, Python 3.13 is already the default. So you have to install Python 3.12 manually before using `pipx`. +On some Linux distributions, Python 3.13 is already the default. In that case, install Python 3.12 manually before using `pipx`. For Arch Linux: @@ -52,7 +52,7 @@ Once you have Python 3.12, run: pipx install git+https://git.kharec.info/Kharec/auditui.git --python python3.12 ``` -As Python <3.14 is supported on `master` branch of the upstream [`audible`](https://github.com/mkb79/Audible), this should be temporary until the next version. +This workaround is temporary and depends on upstream `audible` compatibility updates. ## Upgrade @@ -90,6 +90,8 @@ pipx upgrade auditui Books are downloaded to `~/.cache/auditui/books`. +Downloaded files use a normalized `Author_Title.aax` naming format. For example, `Stephen King` and `11/22/63` become `Stephen-King_11-22-63.aax`. + The `d` key toggles the download state for the selected book: if the book is not cached, pressing `d` will download it; if it's already cached, pressing `d` will delete it from the cache. To check the total size of your cache: