Optimisations and updated readme

2026-07-14 12:50:52 +01:00
parent 9709457b73
commit ff23474a54
33 changed files with 3073 additions and 2426 deletions
@@ -16,6 +16,12 @@ It runs as two connected services:
 - Upload images and other media for use in slides and templates
 - View live screen connections and send player commands

+## Documentation
+
+Player-facing API details live in [docs/api.md](docs/api.md). It covers the player HTTP endpoints for screen playback, playlist data, connections, and commands.
+
+Player websocket behavior lives in [docs/websocket.md](docs/websocket.md). It covers the player control socket, snapshot stream, and the command/message shapes the player accepts.
+
 ## What You Need

 - Docker and Docker Compose