From 534500d21247d4c904090425d3a924c18afea135 Mon Sep 17 00:00:00 2001
From: Evgeny Zinoviev <me@ch1p.io>
Date: Fri, 12 Feb 2021 23:20:45 +0300
Subject: initial

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..752e17e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# inverter-bot
+
+This is a Telegram bot for querying information from an InfiniSolar V family of hybrid solar inverters, in particular
+inverters supported by **isv** utility, which is an older version of **infinisolarctl** from **infinisolar-tools**
+package.
+
+It supports querying general status, such as battery voltage or power usage, printing amounts of energy generated in
+the last days, dumping status or rated information and more.
+
+It requires Python 3.6+ or so.
+
+## Configuration
+
+Configuration is stored in `config.ini` file in `~/.config/inverter-bot`.
+
+Config example:
+```
+token=YOUR_TOKEN
+admins=
+        123456     ; admin id
+        000123   ; another admin id
+isv_bin=/path/to/isv
+use_sudo=0
+```
+
+Only users in `admins` are allowed to use the bot.
+
+## License
+
+BSD-2c
-- 
cgit v1.2.3