Caspar Template

README.md

@@ -65,9 +65,37 @@ The service also supports the oembed.link-style form:
 http://localhost:3000/https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ
 ```
 
+## CasparCG template
+
+Load `/caspar` as the browser template URL. It starts transparent and blank, then
+renders when CasparCG sends `UPDATE` data.
+
+Example template URL:
+
+```txt
+http://localhost:3000/caspar
+```
+
+Example JSON update payload:
+
+```json
+{
+  "url": "https://bsky.app/profile/bsky.app/post/3k...",
+  "width": 1920,
+  "height": 1080,
+  "scale": 1,
+  "transparent": true
+}
+```
+
+The template also accepts a raw URL string or standard CasparCG XML
+`templateData` with component ids such as `url`, `scale`, `fit`, `autoplay`,
+`muted`, `readyDelay`, and `maxWait`.
+
 ## API
 
 - `GET /api/oembed?url=...` returns the matched provider and raw oEmbed data.
+- `GET /caspar` returns the CasparCG update-driven HTML template.
 - `GET /providers` returns the loaded provider patterns.
 - `GET /healthz` returns a health check response.