update readme
This commit is contained in:
parent
63acf4964a
commit
0f4045a1e2
1 changed files with 14 additions and 3 deletions
17
README.md
17
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.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue