rosa/wol-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(README): add example usage of main web page and /targets endpoint

Browse Source
This commit is contained in:
Rosalina
2026-01-28 03:01:04 +01:00
parent 95d0e3eb74
commit 67daf00f04
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -11,6 +11,10 @@ Wake-on-LAN API in Node.js
2. Edit the file and add your targets 2. Edit the file and add your targets
## Usage ## Usage
Navigate to `http://localhost:9999` and just click the target you want to wake up.
Or:
### POST to `/wake` ### POST to `/wake`
```bash ```bash
curl -X POST -H "Content-Type: application/json" -d '{ curl -X POST -H "Content-Type: application/json" -d '{
@@ -23,6 +27,11 @@ curl -X POST -H "Content-Type: application/json" -d '{
curl http://localhost:9999/wake?mac=00:AA:BB:CC:DD:EE curl http://localhost:9999/wake?mac=00:AA:BB:CC:DD:EE
``` ```
### GET to `/targets`
```bash
curl http://localhost:9999/targets
```
### GET to `/wake/:name` ### GET to `/wake/:name`
```bash ```bash
curl http://localhost:9999/wake/<target name> curl http://localhost:9999/wake/<target name>