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

docs: update roadmap and main description

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2025-12-16 03:35:16 +01:00
parent c65e949731
commit aa5998c3e3
1 changed files with 3 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,14 +1,6 @@
# auditui # auditui
A terminal-based user interface (TUI) client for Audible, written in Python 3. A terminal-based user interface (TUI) client for Audible, written in Python 3 : listen to your audiobooks (even offline), browse and manage your library, and more!
Listen to your audiobooks or podcasts, browse your library, and more.
## What it does and where are we
The project offers a TUI interface for browsing your Audible library, listing your books with progress information. You can sort by progress or title, show all books, or show only unfinished books which is the default.
You can also play a book by pressing `Enter` on a book in the list, and pause/resume the playback by pressing `Space`. `Left` and `Right` let you move 30 seconds backward/forward.
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.
@@ -36,6 +28,7 @@ Please also note that as of now, you need to have [ffmpeg](https://ffmpeg.org/)
| Key | Action | | Key | Action |
| ------------ | -------------------------- | | ------------ | -------------------------- |
| `?` | Show help screen |
| `n` | Sort by name | | `n` | Sort by name |
| `p` | Sort by progress | | `p` | Sort by progress |
| `a` | Show all/unfinished | | `a` | Show all/unfinished |
@@ -60,6 +53,7 @@ Please also note that as of now, you need to have [ffmpeg](https://ffmpeg.org/)
- [x] add control to go to the previous/next chapter - [x] add control to go to the previous/next chapter
- [x] save/resume playback of a book from the last position, regardless of which device was used previously - [x] save/resume playback of a book from the last position, regardless of which device was used previously
- [x] download/remove a book in the cache without having to play it - [x] download/remove a book in the cache without having to play it
- [x] add a help screen with all the keybindings
- [ ] increase/decrease reading speed - [ ] increase/decrease reading speed
- [ ] mark a book as finished or unfinished - [ ] mark a book as finished or unfinished
- [ ] get your stats in a separated pane - [ ] get your stats in a separated pane