Add rest api documentation

AndrewSB · Dec 29, 2019 · 051db5f · 051db5f
1 parent 97b8a92
commit 051db5f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/Screenshots/MainWindow.png b/Screenshots/MainWindow.png
diff --git a/restapi.md b/restapi.md
@@ -1,12 +1,11 @@
 # REST API
 
-If enabled, Jared exposes a webserver on the port `3000`. 
-
+If enabled, Jared exposes a webserver on the port `3000`. You can configure what port it starts up in the `config.json` file under the `webserver.port` property.
 
 ## Endpoints
 `POST` `/message` 
 
-This allows you to send (current) text messages to any Person. You will receive a 200 status code if Jared successfully parsed your request and passed it on to the handler. Otherwise, you may receive a 400 bad request exception. 
+This allows you to send text messages to any Person. You will receive a 200 status code if Jared successfully parsed your request and passed it on to the handler. Otherwise, you may receive a 400 bad request exception. Note that the message will not be send if Jared is not "enabled" in the UI.
 
 ```
 {