diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ac3b04 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# promstats + +> 📊 Access Prometheus + Node Exporter hardware metrics through simple JavaScript functions. + +`promstats` is a lightweight Node.js package that fetches and parses hardware and system metrics (like CPU and system info) from a Prometheus server running with Node Exporter. It wraps raw metrics into clean JS functions so you can integrate them into your apps with ease. + +--- + +## ✨ Features + +- 🔧 Fetches real-time metrics from Prometheus +- 📦 Simple API for accessing CPU and system-level data +- 🧠 Intelligent parsing of Node Exporter metrics +- ⚡ Written in TypeScript + +--- + +## 🚀 Installation +```bash +npm install promstats +``` \ No newline at end of file