Merge branch 'main' of https://github.com/codeshelldev/wol-client

Author: CodeShellDev

README.md

@@ -1,9 +1,13 @@
 # WoL Client
 
-WoL Client is a Wake-on-LAN Docker Container, that wakes up queried Machines.
+**WoL Client** is a Docker container for Wake-on-LAN (WoL) that allows you to remotely wake up machines on your network.
+
+You can combine it with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) to provide a web-based UI for easier management.
 
 ## Installation
 
+Add the following to your `docker-compose.yaml`:
+
 ```yaml
 ---
 services:
@@ -22,23 +26,57 @@ networks:
   network:
 ```
 
-Combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a graphical interface.
-
 ## Usage
 
-Send Wakeup-Packtes to host at `192.168.1.1` [`00:00:00:00:00:00`]
+Send a Wake-on-LAN packet to a host. For example, to wake a machine at `192.168.1.1` with MAC address `00:00:00:00:00:00`:
 
-```curl
-curl -X POST "Content-Type: application/json" -d '{ "ip":"192.168.1.1", "mac": "00:00:00:00:00:00", "startupTime": 5 }' http://wol-client
+```bash
+curl -X POST "http://wol-client:5555/start" \
+     -H "Content-Type: application/json" \
+     -d '{
+           "ip": "192.168.1.1",
+           "mac": "00:00:00:00:00:00",
+           "startupTime": 5
+         }'
 ```
 
-## Contributing
+You can also specify a different IP address for pinging:
+
+```bash
+curl -X POST "http://wol-client:5555/start" \
+     -H "Content-Type: application/json" \
+     -d '{
+           "ip": "192.168.1.100",
+           "addr": "192.168.1.1",
+           "mac": "00:00:00:00:00:00",
+           "startupTime": 5
+         }'
+```
+
+> [!NOTE]
+> 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.
+
+**WoL Client** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at `ws://wol-client/ws`.  
+This WebSocket will send updates for each step of the process. The response contains:
 
-Want to change something, have suggestions?
-Fell free to open up an issue or to create a Pull Request.
+- `success`: `true` if the process finished successfully.
+- `error`: `true` if the process failed.
+- `message`: descriptive information about what happened.
+
+## Configuration
+
+### `PING_INTERVAL`
+
+Interval in seconds for pinging when `startupTime` is not provided.
+
+### `PING_RETRIES`
+
+Number of retries for pinging when `startupTime` is not provided before timing out.
+
+## Contributing
 
-This project is rather small so there might not be many additions anytime soon.
+Have suggestions or improvements? Feel free to open an issue or submit a Pull Request.
 
 ## License
 
-[MIT](https://choosealicense.com/licenses/mit/)
+This project is licensed under the [MIT License](./LICENSE).