You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/templates/README.template.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,12 +81,20 @@ curl -X POST "http://wol-client:5555/start" \
81
81
> [!NOTE]
82
82
> 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.
83
83
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
86
85
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:
0 commit comments