summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9f7f33c..1274408 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
# 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.
+This is a Telegram bot for querying information from an InfiniSolar V family of hybrid solar inverters.
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.
+## Requirements
+
+- **`inverterd`** from [inverter-tools](https://github.com/gch1p/inverter-tools)
+- **[`inverterd`](https://pypi.org/project/inverterd/)** python library
+- Python 3.6+ or so
+
## Configuration
Configuration is stored in `config.ini` file in `~/.config/inverter-bot`.