From 6f1a6b50dc51d0be8f4f4ab577f80a9dc580541d Mon Sep 17 00:00:00 2001
From: PhatPhuckDave <david.majdandzic@hotmail.com>
Date: Sun, 5 Oct 2025 17:59:16 +0200
Subject: [PATCH] Hallucinate the whole ass readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80380c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+## LibreHardwareMonitor Exporter
+
+Minimal Prometheus exporter using `LibreHardwareMonitorLib` to expose basic hardware metrics (CPU, GPU, memory, motherboard, network, storage).
+
+### Run
+
+- Build and run the console app.
+- Endpoint: `http://localhost:9646/metrics` (set `PORT` env var to change port)
+- Some sensors may require administrator privileges.
+
+### Prometheus scrape config
+
+```yaml
+scrape_configs:
+  - job_name: lhm_exporter
+    static_configs:
+      - targets: ['localhost:9646']
+```
+
+### Metrics
+
+Exports gauges like:
+- `lhm_temperature_celsius`
+- `lhm_load_percent`
+- `lhm_clock_mhz`
+- `lhm_power_watts`
+- `lhm_fan_rpm`
+- `lhm_voltage_volts`
+
+Each metric includes `hardware` and `sensor` labels.
+
+### Upstream library
+
+Powered by LibreHardwareMonitor: [GitHub repository](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor)