From 7876dd605a8e4b595436035a87a5151be187c01d Mon Sep 17 00:00:00 2001 From: FxQnLr Date: Mon, 15 Apr 2024 21:09:16 +0200 Subject: Added Usage (start request) to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index cf536c4..e84d646 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ services: - ./logs:/logs network_mode: host ``` +# Usage ## Register Device A device is registered with a PUT request to the server with a JSON representation of the device as payload. | field | description | example | @@ -59,3 +60,8 @@ curl -X PUT http:///device \ "ip": "" }' ``` +## Start Device +The easiest way to start a device is using a GET request with its id: +```sh +curl http:///start/ +``` \ No newline at end of file -- cgit v1.2.3