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

Author: CodeShellDev

README.md

@@ -0,0 +1,32 @@
+# WoL Client
+
+WoL Client is a Wake-on-LAN Docker Container, that wakes up queried Machines.
+
+## Installation
+
+```yaml
+---
+services:
+  wol-client:
+    image: ghcr.io/codeshelldev/wol-client
+    container_name: wol-client
+```
+
+## Usage
+
+Send Wakeup-Packtes to host at `192.168.1.1` [`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
+```
+
+## Contributing
+
+Want to change something, have suggestions?
+Fell free to open up an issue or to create a Pull Request.
+
+This project is rather small so there might not be many additions anytime soon.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)