1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5bf92e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# lua-inverterd-client
+
+[inverterd](https://github.com/gch1p/inverter-tools) client for Lua.
+
+## Usage example
+
+```lua
+local inverter = require('inverter')
+local json = require('json')
+
+local inv = inverter.create('192.168.1.223', 8305)
+local ok, err = inv:connect()
+
+ok, status = inv:exec('get-status')
+if not ok then
+    print('error: ' .. status)
+else
+    status = json.decode(status)
+    print(status.data.battery_voltage.value .. ' ' .. status.data.battery_voltage.unit)
+end
+```
+
+## License
+
+MIT