updating docs

README.md

@@ -1 +1,15 @@
-batriumlog
+# BatriumLog
+[<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/njfaria/batriumlog">](https://github.com/njfaria/batriumlog/releases)
+[<img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/njfaria/batriumlog/total">](https://github.com/njfaria/batriumlog/releases/latest)
+[<img alt="donate" src="https://img.shields.io/badge/donate-Paypal-green">](https://www.paypal.com/donate?hosted_button_id=ZDTGKU48JP678&source=url)
+[<img alt="Suporter Names" src="https://img.shields.io/badge/suporter-names-orange">](/docs/suporternames.md)
+
+Batrium bms logger
+Sends data per MQTT to your local broker ( for Home Automation for example ) and to your local Emoncms account.
+Interfaces with solpiplog to change the inverter to switch to grid or solar, based on predifined SOC values.
+
+## [Values sent over MQTT](/docs/mqttvalues.md)
+
+## Appearance
+![batriumlog](batriummain.png)
+![batriumlog](batriumexpansion.png)

docs/mqttvalues.md

@@ -0,0 +1,32 @@
+## Values sent over MQTT
+
+solpiplog//batrium/volt
+solpiplog/batrium/ampere
+solpiplog/batrium/soc
+solpiplog/batrium/status
+solpiplog/batrium/cell1minv
+solpiplog/batrium/cell1maxv
+solpiplog/batrium/cell2minv
+solpiplog/batrium/cell2maxv
+solpiplog/batrium/cell3minv
+solpiplog/batrium/cell3maxv
+solpiplog/batrium/cell4minv
+solpiplog/batrium/cell4maxv
+solpiplog/batrium/cell5minv
+solpiplog/batrium/cell5maxv
+solpiplog/batrium/cell6minv
+solpiplog/batrium/cell6maxv
+solpiplog/batrium/cell7minv
+solpiplog/batrium/cell7maxv
+solpiplog/batrium/cell8minv
+solpiplog/batrium/cell8maxv
+solpiplog/batrium/chargeva
+solpiplog/batrium/dischargeva
+solpiplog/batrium/relais1
+solpiplog/batrium/relais2
+solpiplog/batrium/relais3
+solpiplog/batrium/relais4
+solpiplog/batrium/output5
+solpiplog/batrium/output6
+solpiplog/batrium/output7
+solpiplog/batrium/output8