From ad8d73f6e5a3e2eb0233ac61e64529ac14df6ddc Mon Sep 17 00:00:00 2001
From: Bo Jeanes <me@bjeanes.com>
Date: Sun, 4 Sep 2022 08:43:53 +1000
Subject: [PATCH] Update README.md

---
 README.md | 32 ++++++--------------------------
 1 file changed, 6 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index a96663f..5e117b9 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,14 @@
 # ModbusMQTT
 
-Very rough for now.
+A bridge between Modbus devices and MQTT.
 
-## Topic spec
+It is early days, but the plan is:
 
-```
-prefix/status -> { "status": "running" } # last-will message here too
+* Support custom Modbus protocols (Sungrow WiNet-S has been implemented)
+* Support _setting_ holding registers over MQTT
+* Support optional auto-configuration of Home Assistant entities, including using [MQTT Number](https://www.home-assistant.io/integrations/number.mqtt/) et al for holding registers, to allow setting the value.
 
-prefix/connect/<connection> <- {
-        "host": "localhost",
-        "port": 502,
-        "slave": 1,
-    }
 
-prefix/status/<connection> -> {
-        "host": "localhost",
-        "port": 502,
-        "slave": 1,
-        "status": "connected"
-    }
-
-prefix/logs/<connection> -> { "message": "log message", level: "level" }
-
-prefix/connection/<connection>/monitor[/opt-name] <- {
-        "address": 5100,
-        "type": "holding|input",
-        "count": 1,
-        "interval": 10, // seconds
-}
-```
 
 ## Similar projects
 
@@ -96,4 +76,4 @@ prefix/connection/<connection>/monitor[/opt-name] <- {
     "period": "90s"
   }]
 }
-```
\ No newline at end of file
+```