summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b1a2f9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# susan-scripts
+
+Automation scripts for Susan (home server). Managed by Caine.
+
+## Scripts
+
+| Script | Purpose |
+|--------|---------|
+| `overnight_transcoder.py` | Nightly HEVC transcoding of video library |
+| `morning_report.py` | Daily system health report (email) |
+| `music_recommender.py` | Last.fm-based music discovery + Soulseek download |
+| `import_music.sh` | FLAC→Opus transcoding + beets tagging for new albums |
+| `transcode_album.sh` | Manual album transcode helper |
+| `scrape_discogs_labels.py` | Scrape Discogs labels for music pipeline |
+| `generate_stats_page.py` | Retro stats page generator |
+| `decrypt_bookmarks.js` | Floccus bookmark decryption |
+| `add_bookmark.js` | Add bookmark to Floccus XBEL |
+| `add_bookmark_to_wishlist.js` | Add bookmark to wishlist folder |
+
+## Setup
+
+- Copy `music_config.example.json` to `music_config.json` and fill in credentials.
+- Bookmark scripts read password from `/etc/automation/bookmarks.json`.