docs: rework README and store feature list

Give each feature a bolded name with a short description, add large-library
and offline-mode points, and bring the store description's order and content
in line with the README.
This commit is contained in:
austinried
2026-10-08 11:10:34 +00:00
parent 05de10c912
commit acd087cfe0
2 changed files with 32 additions and 26 deletions
+20 -14
View File
@@ -28,19 +28,17 @@ subtracks is an open source Android client for [Subsonic-compatible](http://www.
## Features
- Home screen to browse your library over many categories, genres, and more
- Album and artist artwork, shown full-resolution in the detail and now playing views
- Downloads with album, artist and playlist bulk downloads, download quality and a metered-connection toggle
- Search across albums, artists, playlists and songs, with per-list sort and filter controls
- Gapless playback, an editable queue you can reorder and jump through, and loop and shuffle modes
- Up next queue to add items into the currently playing queue without rewriting it
- Multiple server support with quick switching
- Stream quality (bitrate and format) settings for Wi-Fi and mobile and automatic switching
- Scrobbling and starred items, cached while offline and sent back to the server when online
- Media notification and headset/Bluetooth controls
- Adaptive theming from the current song's artwork
The full library is mirrored at sync, so browsing, searching, sorting and filtering all work without waiting on the server. Only media and artwork are fetched on demand, and not even that when they're already downloaded.
- **Large Libraries:** Built for very large libraries, from syncing the whole collection to playing playlists with thousands of tracks.
- **Downloads:** Song and bulk downloads, with download quality (encoding, bitrate) and metered-connection settings.
- **Offline Mode:** Stars, scrobbles and play counts queue up while you're offline and sync back to the server when you're online again.
- **Artwork-first:** Album and artist art everywhere, shown full-resolution in the detail and now playing views.
- **Adaptive Theming:** Colours drawn from the current song's artwork.
- **Search:** Fast search across the whole library, with per-list sort and filter controls.
- **Playback:** Gapless playback, an editable queue you can reorder and jump through, plus loop and shuffle modes.
- **Up Next:** Add items into the currently playing queue without rewriting it.
- **Multiple Servers:** Connect several servers and switch between them quickly.
- **Stream Quality:** Bitrate and format settings for Wi-Fi and mobile, with automatic switching.
- **System Controls:** Media notification and headset/Bluetooth controls.
## Building
@@ -55,6 +53,14 @@ gradle :app:assembleDebug
Test, lint and screenshot commands, plus the integration harness, are documented in [AGENTS.md](AGENTS.md). The architecture is described in [docs/architecture.md](docs/architecture.md).
## Contributing
The GitHub repository [austinried/subtracks](https://github.com/austinried/subtracks) is a mirror of the repo hosted on my personal (private) code forge that syncs whenever I commit to it.
Bug reports and feature requests are accepted on GitHub, as well as pull requests, but:
* A well-crafted issue with clear reproduction and logs for bugs or mock-ups and use case details for features is preferred over a pull request
* Pull requests will be pulled in as patches to my code forge and then synced back (you'll still be the author, I'll be shown as the committer)
## Translations
Want to see subtracks in your language? Visit the project on [Weblate](https://hosted.weblate.org/engage/subtracks/) to help!
@@ -65,7 +71,7 @@ Want to see subtracks in your language? Visit the project on [Weblate](https://h
## AI usage disclosure
This project contains code and documentation generated by LLM, which is created via human prompting, iteration and review.
This project contains code and documentation generated by LLM, which is created via human prompting, iteration and review. The current native rewrite is based on two (and a half) other iterations of this project that I coded by hand, so the architecture and other decisions behind that are all still coming from me.
## License
+12 -12
View File
@@ -1,16 +1,16 @@
subtracks is an open source Android client for Subsonic-compatible servers, including Navidrome, gonic, LMS, Nextcloud Music and more. It is built natively with Kotlin and Jetpack Compose, and gives you clean, convenient access to your music library in the style of a modern media player.
Features
- Home screen to browse your library over many categories, genres, and more
- Album and artist artwork, shown full-resolution in the detail and now playing views
- Downloads with album, artist and playlist bulk downloads, download quality and a metered-connection toggle
- Search across albums, artists, playlists and songs, with per-list sort and filter controls
- Gapless playback, an editable queue you can reorder and jump through, and loop and shuffle modes
- Up next queue to add items into the currently playing queue without rewriting it
- Multiple server support with quick switching
- Stream quality (bitrate and format) settings for Wi-Fi and mobile and automatic switching
- Scrobbling and starred items, cached while offline and sent back to the server when online
- Media notification and headset/Bluetooth controls
- Adaptive theming from the current song's artwork
- Large Libraries: built for very large libraries, from syncing the whole collection to playing playlists with thousands of tracks.
- Downloads: song and bulk downloads, with download quality (encoding, bitrate) and metered-connection settings.
- Offline Mode: stars, scrobbles and play counts queue up while you're offline and sync back to the server when you're online again.
- Artwork-first: album and artist art everywhere, shown full-resolution in the detail and now playing views.
- Adaptive Theming: colours drawn from the current song's artwork.
- Search: fast search across the whole library, with per-list sort and filter controls.
- Playback: gapless playback, an editable queue you can reorder and jump through, plus loop and shuffle modes.
- Up Next: add items into the currently playing queue without rewriting it.
- Multiple Servers: connect several servers and switch between them quickly.
- Stream Quality: bitrate and format settings for Wi-Fi and mobile, with automatic switching.
- System Controls: media notification and headset/Bluetooth controls.
The full library is mirrored at sync, so browsing, searching, sorting and filtering work offline. Only media and artwork are fetched on demand, and not even that when they're already downloaded. subtracks is free software (GPL-3.0), has no ads and no telemetry, and uses only free/libre dependencies.
subtracks is free software (GPL-3.0), with no ads or telemetry.