From 99142b6900f9a35d03246c4106d83c44f97e7792 Mon Sep 17 00:00:00 2001
From: Ben Morgan <ben.morgan5000@gmail.com>
Date: Mon, 21 Aug 2023 17:57:52 -0600
Subject: [PATCH] Create README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..980d30f
--- /dev/null
+++ b/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