From 7526db589ff0698fad7601fbeeff1b6962628800 Mon Sep 17 00:00:00 2001
From: James Barnett <james.barnett@fivium.co.uk>
Date: Mon, 2 Apr 2018 00:01:49 +0100
Subject: Update readme

---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 4f2e62e..62d8840 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
-# tplink-monitor
-An energy monitoring dashboard for TP-Link smart plugs
+# TPLink Monitor
+
+A web based monitoring dashboard displaying energy usage data and statistics for TP-Link HS110 smart plugs.
+Written in Node.js + Express.
+
+<p align="center">
+  <img alt="Screenshot" src="https://james-barnett.net/files/tplink-monitor/screenshots/em-res.png">
+</p>
+
+# Features
+- Automatically scans for TP-Link smart plug devices on your local network on server start.
+- Realtime current, voltage, power readings.
+- Recent power usage trend chart.
+- Plug on/off state and uptime.
+- Daily & montly energy usage totals and averages.
+- Historical daily and monthly energy usage charts.
+
+# Installation
+Prepacked releases comming soon.
+For now:
+```sh
+$ git clone https://github.com/jamesbarnett91/tplink-monitor && cd tplink-monitor
+$ npm install
+$ npm start
+```
+
+# TODOs
+- [x] Show historical data
+- [ ] Switch to websockets
+- [ ] Rescan for devices on the fly
+- [ ] Build dists
+- [ ] Docker image
+- [ ] Support switching between multiple plugs
-- 
cgit v1.2.3