Skip to content

Commit f3acdaa

Browse files
Update README.md
1 parent f64779c commit f3acdaa

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,17 +114,20 @@ services:
114114
- wol.autostop=true
115115
```
116116
117-
**WoL Dockerized** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at:
117+
## WebSocket Updates
118+
119+
The `/wake` endpoint returns a `client_id`.
120+
Use it to open a WebSocket connection:
118121

119122
```
120123
ws://wol-dockerized:7777/ws
121124
```
122125

123-
The WebSocket sends updates for each step of the process. The response contains:
126+
The WebSocket sends structured updates during the startup sequence:
124127

125-
- `success`: `true` if the process finished successfully.
126-
- `error`: `true` if the process failed.
127-
- `message`: descriptive information about what happened.
128+
- `success`: `true` when the process completes
129+
- `error`: `true` if startup fails
130+
- `message`: descriptive status or error details
128131

129132
## Contributing
130133

0 commit comments

Comments
 (0)