aboutsummaryrefslogtreecommitdiff
path: root/cmd
diff options
context:
space:
mode:
Diffstat (limited to 'cmd')
-rw-r--r--cmd/mpd-scrobbler/README.org22
1 files changed, 22 insertions, 0 deletions
diff --git a/cmd/mpd-scrobbler/README.org b/cmd/mpd-scrobbler/README.org
new file mode 100644
index 0000000..8c0a7d9
--- /dev/null
+++ b/cmd/mpd-scrobbler/README.org
@@ -0,0 +1,22 @@
+#+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).
+* Install
+The Makefile assumes the system is running Linux and systemd.
+
+Run =make install=. This will:
+- install the binary in your =GOPATH= (using =go install=)
+- install a systemd unit file under =$HOME/.config/systemd/user=
+- reload systemd unit files
+- start the service