From 0f4045a1e2356b5bf51272bd8d23d93bd1c8c6a5 Mon Sep 17 00:00:00 2001 From: ari melody Date: Fri, 24 Jul 2026 17:54:07 +0100 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f90f62c..7872096 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ handy, custom-built tools and utilities for my livestreams! -## learning +## setup + +run once, then edit the generated config files to taste: +- **linux:** `~/.config/ari-stream-tools/config.toml` +- **macOS:** `~/Library/Application Support/ari-stream-tools/config.toml` +- **windows:** `%APPDATA%\ari-stream-tools\config.toml` + +incompatible or unconfigured services will simply not run: you're welcome to use only the services you need and/or care about. + +## endpoints + +### learning endpoints and views for "ari is learning!" streams. @@ -13,7 +24,7 @@ endpoints and views for "ari is learning!" streams. - **`GET /learning/brb`**: "be right back!" view - **`GET /learning/bye`**: stream ending view -## music +### music endpoints for a music status indicator. @@ -25,7 +36,7 @@ endpoints for a music status indicator. - **`GET /music/artwork`**: serves the currently playing track artwork - **`GET /music`**: music status indicator -## twitch +### twitch endpoints for twitch events and labels.