From 27e6a74a161b8f9e9fa283aaf323ce98f324c6a0 Mon Sep 17 00:00:00 2001 From: Chase Dumphord <60725859+ced4568@users.noreply.github.com> Date: Tue, 28 Apr 2026 11:37:33 -0500 Subject: [PATCH] Update README.md Added Quick start section --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 24b4b0b..5954508 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,37 @@ It simulates real-world **SRE / Platform Engineering environments**, delivering: --- +## 🚀 Quick Start + +### Prerequisites + +- Linux server or VM +- Python 3 installed +- Prometheus installed +- Grafana installed +- Network access to homelab systems + +--- + +### Run Service Health Check + +bash python3 scripts/service-health-check.py + +--- + +### Run Prometheus + +bash prometheus --config.file=prometheus/prometheus.yml + +--- + +### Access Services + +- Prometheus: http://localhost:9090 +- Grafana: http://localhost:3000 + +--- + ## 📡 Monitored Systems | Target | Example Metrics |