From fb6e644e8a73a0b4e1a112d55f437c9c2eb3eb07 Mon Sep 17 00:00:00 2001 From: William Clark Date: Wed, 13 Dec 2023 20:05:04 +0000 Subject: [PATCH] README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aae3d07..66c7536 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ In this case, the `[DB]` field in `config.toml` can be left empty except for `ty ## API -The TH7 implements a simple REST API along with a websocket endpoint that periodically dumps data probably relevant to user logging applications. +The TH7 implements a simple REST API along with a websocket service that periodically dumps data, probably relevant to user logging applications. #### REST API @@ -162,12 +162,13 @@ POST v1/config/device POST v1/config/channel/:id --- Modify or add a field in the database config map object --- +--- This endpoint must be explicitly enabled --- POST v1/config/db ``` #### WebSocket -The WebSocket endpoint requires no configuration, and will dump data at a regular interval to any active client connection. The data is functionally identical to `GET v1/data`. Example: +The WebSocket endpoint is available on `/ws` and requires no configuration to use. It will dump data at a regular interval to any active client connection. The data is functionally identical to `GET v1/data`. Example: ```json {