Skip to content

Commit f64779c

Browse files
authored
Update README.template.md
1 parent ec6ca21 commit f64779c

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

.github/templates/README.template.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,17 +97,20 @@ Example `docker-compose` configuration for the container:
9797
{{{ #://examples/jellyfin.docker-compose.yaml }}}
9898
```
9999

100-
**WoL Dockerized** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at:
100+
## WebSocket Updates
101+
102+
The `/wake` endpoint returns a `client_id`.
103+
Use it to open a WebSocket connection:
101104

102105
```
103106
ws://wol-dockerized:7777/ws
104107
```
105108

106-
The WebSocket sends updates for each step of the process. The response contains:
109+
The WebSocket sends structured updates during the startup sequence:
107110

108-
- `success`: `true` if the process finished successfully.
109-
- `error`: `true` if the process failed.
110-
- `message`: descriptive information about what happened.
111+
- `success`: `true` when the process completes
112+
- `error`: `true` if startup fails
113+
- `message`: descriptive status or error details
111114

112115
## Contributing
113116

0 commit comments

Comments
 (0)