From b18a6c210427a97d93a0aab2bf3b8c4710e7398d Mon Sep 17 00:00:00 2001
From: Philipp Wolfer <ph.wolfer@gmail.com>
Date: Sat, 24 May 2025 18:30:26 +0200
Subject: [PATCH] Update changelog and README

Clarify that some services are not suited for full listen history export
---
 CHANGES.md          | 17 +++++++++++++++++
 README.md           |  8 +++++++-
 config.example.toml |  6 +++++-
 3 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index 486d0ff..5ccf6d0 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,5 +1,22 @@
 # Scotty Changelog
 
+## 0.7.0 - WIP
+- listenbrainz-archive: new backend to load listens and loves from a
+  ListenBrainz export. The data can be read from the downloaded ZIP archive
+  or a directory where the contents of the archive have been extracted to.
+- listenbrainz: faster loading of missing loves metadata using the ListenBrainz
+  API instead of MusicBrainz. Fallback to slower MusicBrainz query, if
+  ListenBrainz does not provide the data.
+- spotify-history: it is now possible to specify the path directly to the
+  `my_spotify_data_extended.zip` ZIP file as downloaded from Spotify.
+- spotify-history: the parameter to the export archive path has been renamed to
+  `archive-path`. For backward compatibility the old `dir-path` parameter is
+  still read.
+- deezer: fixed endless export loop if the user's listen history was empty.
+- dump: it is now possible to specify a file to write the text output to.
+- Fixed potential issues with MusicBrainz rate limiting.
+
+
 ## 0.6.0 - 2025-05-23
 - Fully reworked progress report
   - Cancel both export and import on error
diff --git a/README.md b/README.md
index 6f997ed..b10a030 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ funkwhale            | ✓              | ⨯              | ✓            | -
 jspf                 | ✓              | ✓              | ✓            | ✓
 lastfm               | ✓              | ✓              | ✓            | ✓
 listenbrainz         | ✓              | ✓              | ✓            | ✓
-listenbrainz-archive | ✓              | -              | -            | -
+listenbrainz-archive | ✓              | -              | ✓            | -
 maloja               | ✓              | ✓              | ⨯            | ⨯
 scrobbler-log        | ✓              | ✓              | ⨯            | ⨯
 spotify              | ✓              | ⨯              | ✓            | -
@@ -135,6 +135,12 @@ subsonic             | ⨯              | ⨯              | ✓            | -
 
 See the comments in [config.example.toml](./config.example.toml) for a description of each backend's available configuration options.
 
+**NOTE:** Some services, e.g. the Spotify and Deezer API, do not provide access
+to the user's full listening history. Hence the API integrations are not suited
+to do a full history export. They can however be well used for continuously
+transfer recent listens to other services when running scotty frequently, e.g.
+as a cron job.
+
 
 ## Contribute
 The source code for Scotty is available on [SourceHut](https://sr.ht/~phw/scotty/). To report issues or feature requests please [create a ticket](https://todo.sr.ht/~phw/scotty).
diff --git a/config.example.toml b/config.example.toml
index d01a51a..3acdf88 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -106,6 +106,8 @@ client-secret = ""
 
 [service.spotify-history]
 # Read listens from a Spotify extended history export
+# NOTE: The Spotify API does not allow access to the full listen history,
+#       but only to recent listens.
 backend          = "spotify-history"
 # Path to the Spotify extended history archive. This can either point directly
 # to the "my_spotify_data_extended.zip" ZIP file provided by Spotify or a
@@ -122,7 +124,9 @@ ignore-skipped   = false
 ignore-min-duration-seconds = 30
 
 [service.deezer]
-# Read listens and loves from a Deezer account
+# Read listens and loves from a Deezer account.
+# NOTE: The Deezer API does not allow access to the full listen history,
+#       but only to recent listens.
 backend       = "deezer"
 # You need to register an application on https://developers.deezer.com/myapps
 # and set the client ID and client secret below.