Create README.md

README.md

@@ -0,0 +1,28 @@
+# MetricsAPI
+Lightweight Flask API for Linux monitoring
+
+## Overview
+MetricsAPI is an extremely lightweight API built with Flask that I created to monitor my home server setup. Personally, I display these metrics on a Rainmeter dashboard, but you can choose to create anything you like.
+
+### Features
+- Lightweight
+- Status webpage
+- Per-core and packaged CPU metrics
+  - Model name
+  - Address sizes
+  - Processor speed
+  - User, system, idle, etc. load measures.
+- Temperature data
+  - CPU
+  - Motherboard
+  - ... and more (depends on your machine)
+- Volume information
+  - Space remaining
+  - Read/written
+  - Read/write per second
+- IP addresses
+
+### Future Work
+- Network up/down
+
+## Installation