From 3e117909da12489d1c15d18438977372e63f4077 Mon Sep 17 00:00:00 2001 From: Arvuno Date: Wed, 3 Jun 2026 19:43:07 +0000 Subject: [PATCH] docs(readme): document AcoustID API key + retag gotcha The AcoustID section in the README was a one-liner that did not explain how to get the API key or why the retag action sometimes appears to do nothing. Expand the section with: - A short paragraph pointing users at acoustid.org/new-application and the Settings entry where the key belongs. - A note cross-referencing issue #704: the retag path treats an existing MUSICBRAINZ_TRACKID tag as a short-circuit, so removing the cached tag is the documented workaround. This gives a definitive answer until the retag path itself is fixed. No code or behavioural change. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a79eeb7e..325ee12b 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,21 @@ SoulSync bridges streaming services to your music library with automated discove - Catches wrong versions (live, remix, cover) even from streaming API sources - Fail-open design: verification errors never block downloads +#### AcoustID API key + +AcoustID verification is opt-in. To enable it, request a free API key +at and paste it into +Settings → AcoustID. Without a key, downloads still complete but the +verification step is skipped silently. + +If a track was previously tagged by AcoustID but the retag action in +the AcoustID Scanner no longer changes anything, see issue #704 — the +most common cause is that the file already carries a +`MUSICBRAINZ_TRACKID` tag, which the retag step uses as a short-circuit +and therefore never overwrites. Removing the cached +`MUSICBRAINZ_TRACKID` (and the `ACOUSTID_ID` if present) from the file +restores the retag. + ### Metadata & Enrichment **10 Background Enrichment Workers**: Spotify, MusicBrainz, iTunes, Deezer, Discogs, AudioDB, Last.fm, Genius, Tidal, Qobuz