From 40123ed858da2a1464cfde2b869250870fcd4f58 Mon Sep 17 00:00:00 2001 From: Admin Date: Mon, 9 Nov 2015 16:47:38 -0600 Subject: [PATCH] Updating document for REST usage. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fba634..8272b7b 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,13 @@ Configure by going to the url for the host you are running on or localhost with ``` http://: ``` -## Command line configure +## Command line usage +This section will describe the REST api available for configuration. The REST examples are all formatted for easy reading, the actual usage should be like this: +``` +{"var1":"value1","var2":"value2","var3:"value3"} +``` +As it should be in all one big string and not separated by returns,tabs or spaces. +### Add a device Register a device via REST by by using a tool and the url, for example: ``` POST http://host:8080/api/devices