diff --git a/README.md b/README.md index 135e1cc..f48ba03 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,32 @@ An all-in-one daemon that exposes an HTTP frontend to ### Examples +Parameters for each region can be passed in one or many calls: ``` -curl 192.168.1.17:9000/api/time?ts=1712320920 - -curl 192.168.1.17:9000/api/osd/0?font=comic&size=32.0&text=Frontdoor +curl "192.168.1.17:9000/api/osd/0?font=comic&size=32.0&text=Frontdoor" curl 192.168.1.17:9000/api/osd/0?posy=72 +``` +Supported fonts (sourced from /usr/share/fonts/truetype/) can render Unicode characters: +``` +curl 192.168.1.17:9000/api/osd/0?text=Entrée +``` + +Specifiers starting with a dollar sign are used to represent real-time statistics: +``` curl "192.168.1.17:9000/api/osd/1?text=$B C:$C M:$M" +``` +Empty strings are used to clear the regions: +``` curl 192.168.1.17:9000/api/osd/2?text= ``` +UTC date and time can be set using Unix timestamps: +``` +curl 192.168.1.17:9000/api/time?ts=1712320920 +``` + ### Technical support and donations Please **_[support our project](https://openipc.org/support-open-source)_** with donations or orders for development or maintenance. Thank you!