about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2021-10-09 13:45:11 -0700
committerFranck Cuny <franck@fcuny.net>2022-06-11 14:32:06 -0700
commit53bf5f0e1b6574a23e11c3200034927dd7f29d43 (patch)
treeee9f327ce0f949495e2904a9f4ad330c4b71432e
parentadd initial go.mod (diff)
downloadworld-53bf5f0e1b6574a23e11c3200034927dd7f29d43.tar.gz
README: add some information about logging
Describe what is being collected.
-rw-r--r--tools/mpd-stats/README.org15
1 files changed, 14 insertions, 1 deletions
diff --git a/tools/mpd-stats/README.org b/tools/mpd-stats/README.org
index 2d06ad9..8765e59 100644
--- a/tools/mpd-stats/README.org
+++ b/tools/mpd-stats/README.org
@@ -1 +1,14 @@
-#+TITLE: mpd-stats
\ No newline at end of file
+#+TITLE: mpd-stats
+
+Log played songs to extract statistics. This is similar to what libre.fm used to do, but locally.
+
+* Logging
+Collect logs from mpd. A log record is composed of the following fields:
+- id: UUID
+- song's name: the name of the song
+- song's album: the name of the album
+- song's artist: the name of the artist
+- song's duration: the duration of the song
+- date: date the song was played
+
+The logs are recorded in a database (sqlite3 to start).