Skip to content

Commit ae6eb94

Browse files
authored
Update README.template.md
1 parent 808a971 commit ae6eb94

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

.github/templates/README.template.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,20 @@ curl -X POST "http://wol-client:5555/start" \
8181
> [!NOTE]
8282
> 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.
8383
84-
**WoL Client** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at `ws://wol-client:5555/ws`.
85-
This WebSocket will send updates for each step of the process. The response contains:
84+
## WebSocket Updates
8685

87-
- `success`: `true` if the process finished successfully.
88-
- `error`: `true` if the process failed.
89-
- `message`: descriptive information about what happened.
86+
The `/start` endpoint returns a `client_id`.
87+
Use it to open a WebSocket connection:
88+
89+
```
90+
ws://wol-client:5555/ws
91+
```
92+
93+
The WebSocket sends structured updates during the startup sequence:
94+
95+
- `success`: `true` when the process completes
96+
- `error`: `true` if startup fails
97+
- `message`: descriptive status or error details
9098

9199
## Configuration
92100

0 commit comments

Comments
 (0)