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

docs: update README with /wake/:name request example

Browse Source
This commit is contained in:
Rosalina
2026-01-28 02:02:26 +01:00
parent 6d39c4b8e9
commit c917fd739a
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -6,8 +6,11 @@ Wake-on-LAN API in Node.js
1. `npm install` 1. `npm install`
2. `npm run start` 2. `npm run start`
## Usage ## Custom targets
1. Copy `targets.example.json` to `targets.json`
2. Edit the file and add your targets
## Usage
### 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 '{
@@ -18,4 +21,9 @@ curl -X POST -H "Content-Type: application/json" -d '{
### GET to `/wake` ### GET to `/wake`
```bash ```bash
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 `/wake/:name`
```bash
curl http://localhost:9999/wake/<target name>
``` ```