Update README

This commit is contained in:
Dominic Grimm 2025-06-19 17:27:58 +02:00
parent 05740326d5
commit cb4a4aed9e
Signed by: dergrimm
SSH key fingerprint: SHA256:0uoWpcqOtkyvQ+ZqBjNYiDqIZY+9s8VeZkkJ/4ryB4E

View file

@ -22,7 +22,7 @@ eink-feed-server
- `GET /api/channel?id=<CHANNEL_ID>`: - `GET /api/channel?id=<CHANNEL_ID>`:
Returns channel configuration. Can be used by a rendering server to get display information about the image channel. Returns channel configuration. Can be used by a rendering server to get display information about the image channel.
- `POST /api/frame?id=<CHANNEL_ID>&orientation=<(portrait|landscape)_(left|right)>`: - `POST /api/frame?id=<CHANNEL_ID>&orientation=<(portrait|landscape)_(left|right)>`:
Accepts a multipart form with a BMP or PNG. Accepts a multipart form with a PNG (or BMP) file.
- `/api/ws/display`: - `/api/ws/display`:
WebSocket endpoint for protobuf communication between a display client and the server. Image data is sent over this socket. WebSocket endpoint for protobuf communication between a display client and the server. Image data is sent over this socket.