From d5c9465f8a72cf4669bb229055f4c4d81546422b Mon Sep 17 00:00:00 2001 From: rosa Date: Tue, 27 Jan 2026 19:59:53 +0100 Subject: [PATCH] docs: update README with usage instructions --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7054528..ad33dcc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # wol-api -Wake-on-LAN API in Bun \ No newline at end of file +Wake-on-LAN API in Node.js + +## Running +1. `npm install` +2. `npm run start` + +## Usage + +### POST to `/wake` +```bash +curl -X POST -H "Content-Type: application/json" -d '{ + "mac": "00:AA:BB:CC:DD:EE" +}' http://localhost:9999/wake +``` + +### GET to `/wake` +```bash +curl http://localhost:9999/wake?mac=00:AA:BB:CC:DD:EE +``` \ No newline at end of file