From 684d6ab857cd36c463e8657ec8efbb6df9500b1d Mon Sep 17 00:00:00 2001
From: john <john@grollerfamily.com>
Date: Mon, 24 Nov 2025 15:21:22 -0700
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..279a3df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# LTE/5G Router Metrics Exporter
+
+This project provides a simple Prometheus exporter that collects signal metrics  
+from a local network device (commonly a home LTE/5G router) by scraping its  
+web interface at `http://192.168.1.1`.
+
+The exporter parses the router’s status page using BeautifulSoup and exposes  
+the following metrics on port **8000**:
+
+- `snr` — Signal-to-Noise Ratio
+- `rsrp` — Reference Signal Received Power
+- `rsrq` — Reference Signal Received Quality
+
+These metrics can be scraped by Prometheus and visualized in Grafana.
+
+---
+
+## Features
+
+- Scrapes metrics directly from your router's HTML status page  
+- Exposes them in Prometheus format  
+- Lightweight and easy to deploy  
+- Designed to run continuously (default refresh interval: **10 seconds**)  
+
+---
+
+## Requirements
+
+Install dependencies:
+
+```bash
+pip install requests beautifulsoup4 prometheus_client