Skip to content

Commit cdd8ed4

Browse files
Update README.md
1 parent ae6eb94 commit cdd8ed4

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,20 @@ curl -X POST "http://wol-client:5555/start" \
9494
> [!NOTE]
9595
> The `startupTime` field may be omitted. In that case, the [`PING_INTERVAL`](#ping_interval) and [`PING_RETRIES`](#ping_retries) settings will be used to periodically ping the host.
9696

97-
**WoL Client** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at `ws://wol-client:5555/ws`.
98-
This WebSocket will send updates for each step of the process. The response contains:
97+
## WebSocket Updates
9998

100-
- `success`: `true` if the process finished successfully.
101-
- `error`: `true` if the process failed.
102-
- `message`: descriptive information about what happened.
99+
The `/start` endpoint returns a `client_id`.
100+
Use it to open a WebSocket connection:
101+
102+
```
103+
ws://wol-client:5555/ws
104+
```
105+
106+
The WebSocket sends structured updates during the startup sequence:
107+
108+
- `success`: `true` when the process completes
109+
- `error`: `true` if startup fails
110+
- `message`: descriptive status or error details
103111

104112
## Configuration
105113

0 commit comments

Comments
 (0)