From b0f9764fcf998f57b57ca954343308a79f02ca31 Mon Sep 17 00:00:00 2001
From: jude <jude@jellywx.com>
Date: Sat, 20 Apr 2024 20:12:27 +0100
Subject: [PATCH] Add intruction for tracked playlist rules

---
 .idea/workspace.xml | 11 +++--------
 README.md           | 19 ++++++++++++++-----
 2 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index d06b362..ed614fa 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -14,13 +14,7 @@
   <component name="ChangeListManager">
     <list default="true" id="52900e09-9584-4b6c-95ff-fbd4ed5d8b2c" name="Changes" comment="Add interface package. Start adding auth stuff for refreshing tokens.">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Cargo.lock" beforeDir="false" afterPath="$PROJECT_DIR$/Cargo.lock" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Cargo.toml" beforeDir="false" afterPath="$PROJECT_DIR$/Cargo.toml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/etc/playlistd.toml" beforeDir="false" afterPath="$PROJECT_DIR$/etc/playlistd/playlistd.toml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/daemon/create_playlists.rs" beforeDir="false" afterPath="$PROJECT_DIR$/src/daemon/create_playlists.rs" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/main.rs" beforeDir="false" afterPath="$PROJECT_DIR$/src/main.rs" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/models.rs" beforeDir="false" afterPath="$PROJECT_DIR$/src/models.rs" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/systemd/playlistd.service" beforeDir="false" afterPath="$PROJECT_DIR$/systemd/playlistd.service" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -165,7 +159,8 @@
       <workItem from="1713385358427" duration="2705000" />
       <workItem from="1713465993328" duration="1750000" />
       <workItem from="1713469457285" duration="6588000" />
-      <workItem from="1713609379678" duration="6626000" />
+      <workItem from="1713609379678" duration="7216000" />
+      <workItem from="1713639881551" duration="450000" />
     </task>
     <task id="LOCAL-00001" summary="Structure">
       <created>1692008860369</created>
diff --git a/README.md b/README.md
index f0584a4..2dfd813 100644
--- a/README.md
+++ b/README.md
@@ -20,19 +20,28 @@ For deploying, these can be configured in `/etc/playlistd.toml`.
 
 ### Container build (Ubuntu 20.04)
 
-`podman run --rm --network=host -v "$PWD":/mnt -w /mnt -e "DATABASE_URL=postgres://jude@127.0.0.1/navidrome-playlists" playlistd cargo deb`
+`podman run --rm --network=host -v "$PWD":/mnt -w /mnt -e "DATABASE_URL=postgres://jude@127.0.0.1/playlistd" playlistd cargo deb`
 
 ## How to use
 
+Each of these will work best when your music library is well organised with Musicbrainz metadata.
+
 ### Tracked playlist
 
 A tracked playlist is a single Subsonic playlist that tracks data from Listenbrainz. For example,
 a playlist that contains your top 15 songs from the past week.
 
-These will work best when your music library is well organised with Musicbrainz metadata.
-
 You can create a tracked playlist by inserting a row into the `tracked_playlist` table.
 
-### Static playlist
+### Tracked playlist rule
 
-TODO, not yet implemented
+A tracked playlist rule is a time-based instruction to create a new tracked playlist. For example,
+a playlist every year that contains your top songs.
+
+You can create a tracked playlist rule by inserting a row into the `create_tracked_playlist` table.
+For a yearly top songs playlist, run the following:
+
+```sql
+INSERT INTO create_tracked_playlist (id, name_template, playlist_size, tracking_user, tracking_type)
+VALUES (gen_random_uuid(), '%Y - Top 100', 100, 'jellywx', 'this_year');
+```