aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..106605b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# inverterd-client
+
+This is a Python [inverterd](https://github.com/gch1p/inverter-tools) client library.
+
+## Installation
+
+It's available on Pypi:
+
+```
+pip install inverterd
+```
+
+## Usage example
+```python
+from inverterd import Client
+
+c = Client(8305, '127.0.0.1')
+c.format('json')
+print(c.exec('get-status'))
+print(c.exec('get-year-generated', (2021,)))
+```
+
+## License
+
+MIT \ No newline at end of file