aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFxQnLr <[email protected]>2024-04-15 21:09:16 +0200
committerFxQnLr <[email protected]>2024-04-15 21:09:16 +0200
commit7876dd605a8e4b595436035a87a5151be187c01d (patch)
treed89f0da1841b984c10a6a24997a8733524b75f75 /README.md
parentfbb8cbc9f36975c4a414c9485347515d16f42333 (diff)
downloadwebol-7876dd605a8e4b595436035a87a5151be187c01d.tar
webol-7876dd605a8e4b595436035a87a5151be187c01d.tar.gz
webol-7876dd605a8e4b595436035a87a5151be187c01d.zip
Added Usage (start request) to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index cf536c4..e84d646 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ services:
24 - ./logs:/logs 24 - ./logs:/logs
25 network_mode: host 25 network_mode: host
26``` 26```
27# Usage
27## Register Device 28## Register Device
28A device is registered with a PUT request to the server with a JSON representation of the device as payload. 29A device is registered with a PUT request to the server with a JSON representation of the device as payload.
29| field | description | example | 30| field | description | example |
@@ -59,3 +60,8 @@ curl -X PUT http://<server-ip>/device \
59 "ip": "<device-ip>" 60 "ip": "<device-ip>"
60 }' 61 }'
61``` 62```
63## Start Device
64The easiest way to start a device is using a GET request with its id:
65```sh
66curl http://<server-ip>/start/<device-id>
67``` \ No newline at end of file