Skip to content

Commit f5bd29e

Browse files
Update README.md
1 parent 40b19ea commit f5bd29e

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# WoL Client
2+
3+
WoL Client is a Wake-on-LAN Docker Container, that wakes up queried Machines.
4+
5+
## Installation
6+
7+
```yaml
8+
---
9+
services:
10+
wol-client:
11+
image: ghcr.io/codeshelldev/wol-client
12+
container_name: wol-client
13+
```
14+
15+
## Usage
16+
17+
Send Wakeup-Packtes to host at `192.168.1.1` [`00:00:00:00:00:00`]
18+
19+
```curl
20+
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
21+
```
22+
23+
## Contributing
24+
25+
Want to change something, have suggestions?
26+
Fell free to open up an issue or to create a Pull Request.
27+
28+
This project is rather small so there might not be many additions anytime soon.
29+
30+
## License
31+
32+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)