aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e07b49a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# inverter-http-proxy
+
+HTTP interface for [inverterd](https://github.com/gch1p/inverter-tools).
+
+## Dependencides
+
+- Python 3
+- `aiohttp` (from Pypi)
+- `inverterd` (from Pypi)
+
+## Usage
+
+Assuming inverterd host is `192.168.1.2`:
+
+```
+inverter-http-proxy --inverter-host 192.168.1.2 --host 127.0.0.1 --port 8080
+```
+
+Then open https://127.0.0.1/get-status/ in the browser. You can replace `get-status`
+with any command supported by inverterd.
+
+Command arguments are not supported at the moment.
+
+## License
+
+MIT \ No newline at end of file