Skip to content

docs: refresh README - #16

Merged
mrsarac merged 2 commits into
mainfrom
docs/readme-refresh
Oct 8, 2026
Merged

mrsarac merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@mrsarac

@mrsarac mrsarac commented Oct 7, 2026

Copy link
Copy Markdown
Member
  • Restructure README: Why, Quick start, How it works (mermaid diagram), Configuration, API, Documentation, Development, Status / limits, License
  • Badges reduced to license and latest release; CI badge and dead demo host reference removed
  • Prometheus metric list corrected to match src/ (added mqtt_publishes_total, active_devices, mqtt_connected, websocket_connections)
  • Status / limits now documents: register writes are acknowledged but not forwarded to the device, no reconnect if a device is down at startup, Modbus TCP host must be an IP address, Docker Compose needs mqtt.host changed
  • Release numbering note kept and moved under Status / limits
  • .gitignore: ignore agent tooling files

@mrsarac
mrsarac merged commit d962642 into main Oct 8, 2026
7 checks passed
@mrsarac
mrsarac deleted the docs/readme-refresh branch October 8, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant