Kharec/auditui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2026-01-06 10:30:29 +01:00
parent 6d246944a3
commit f024128f85
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,9 +1,14 @@
# auditui # auditui
A terminal-based user interface (TUI) client for Audible, written in Python 3: listen to your audiobooks (even offline), browse your library, and more! 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. 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.
## Requirements
- [Python](https://www.python.org/) 3.10-3.12 (3.13+ is not yet supported by `audible` module)
- [ffmpeg](https://ffmpeg.org/) installed to play audio files.
## Features ## Features
- **Browse your library**: View all your Audible audiobooks in a clean, terminal-based interface - **Browse your library**: View all your Audible audiobooks in a clean, terminal-based interface
@@ -15,11 +20,6 @@ Currently, the only available theme is Catppuccin Mocha, following their [style
- **Keyboard-driven**: Fully navigable with keyboard shortcuts for efficient use - **Keyboard-driven**: Fully navigable with keyboard shortcuts for efficient use
- **Two-factor authentication**: Supports OTP for secure login - **Two-factor authentication**: Supports OTP for secure login
## Requirements
- [Python](https://www.python.org/) 3.10-3.12 (3.13+ is not yet supported by `audible` module)
- [ffmpeg](https://ffmpeg.org/) installed to play audio files.
## Installation ## Installation
Use [`pipx`](https://pipx.pypa.io/latest/installation/) to install `auditui`: Use [`pipx`](https://pipx.pypa.io/latest/installation/) to install `auditui`: