From 1211c15e5450dd2021dc03505e0ca9ee34b5cf26 Mon Sep 17 00:00:00 2001 From: Alex Chen Date: Fri, 17 Apr 2026 20:45:16 +0000 Subject: [PATCH 1/2] docs: add Quick Start Guide section to README - Added a new 'Quick Start Guide' section after 'About The Project' - Provides simple 3-step instructions for new users to get started - Helps users get up and running in under 5 minutes This improves the onboarding experience for new users. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index d54dabeb..54747b0a 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,22 @@ By right-sizing your containers with KRR, you can save an average of 69% on clou Read more about [how KRR works](#how-krr-works) +## Quick Start Guide + +Get started with KRR in under 5 minutes: + +```bash +# Install with Homebrew +brew tap robusta-dev/homebrew-krr +brew install krr + +# Verify installation +krr version + +# Run your first scan +krr simple +``` + ## Difference with Kubernetes VPA | Feature 🛠️ | Robusta KRR 🚀 | Kubernetes VPA 🌐 | From a5ef56926bd000f7f273ee93864346eb86f02df4 Mon Sep 17 00:00:00 2001 From: Alex Chen Date: Fri, 17 Apr 2026 20:45:58 +0000 Subject: [PATCH 2/2] docs: add Quick Start Guide section to README - Added a new 'Quick Start Guide' section after 'About The Project' - Provides simple 3-step instructions for new users to get started - Helps users get up and running in under 5 minutes This improves the onboarding experience for new users. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 54747b0a..21125e29 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,35 @@ By right-sizing your containers with KRR, you can save an average of 69% on clou Read more about [how KRR works](#how-krr-works) + + +## Quick Start Guide + +Get up and running with KRR in under 5 minutes: + +### 1. Install KRR + +```bash +pip install robusta-krr +``` + +### 2. Verify Installation + +```bash +krr --help +``` + +### 3. Run Your First Scan + +```bash +krr simple --prometheus-url=http://localhost:9090 +``` + +That's it! You now have recommendations for optimizing your Kubernetes resources. + +For more details, see the full [Installation](#installation) and [Usage](#usage) sections below. + + ## Quick Start Guide Get started with KRR in under 5 minutes: