Skip to content

docs: add Quick Start Guide section to README #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vincent067 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add Quick Start Guide section to README #515

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1211c15
docs: add Quick Start Guide section to README
Apr 17, 2026
a5ef569
docs: add Quick Start Guide section to README
Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,51 @@ 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 -->

## 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:

```bash
# Install with Homebrew
brew tap robusta-dev/homebrew-krr
brew install krr

# Verify installation
krr version

# Run your first scan
krr simple
```
Comment on lines +135 to +149
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove duplicate Quick Start Guide heading and merge install paths.

Line 135 introduces a second ## Quick Start Guide, which triggers MD024 and makes onboarding repetitive. Keep one heading and present Homebrew as an alternative install option under the same section.

Proposed cleanup 
-## 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
-```
+### Alternative Install (Homebrew)
+
+```bash
+brew tap robusta-dev/homebrew-krr
+brew install krr
+```
+
+Then continue with verification and first scan from the steps above.
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 135-135: Multiple headings with the same content

(MD024, no-duplicate-heading)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 135 - 149, Remove the duplicate "## Quick Start
Guide" heading and merge the Homebrew instructions under the existing Quick
Start section by turning the Homebrew block into a subordinate heading (e.g.,
"### Alternative Install (Homebrew)") and keeping only the Homebrew install
commands in that block (brew tap robusta-dev/homebrew-krr; brew install krr);
then ensure the verification ("krr version") and first-scan ("krr simple") steps
remain once, after the install alternatives, so the flow is: main Quick Start
heading → primary install steps → "Alternative Install (Homebrew)" with just the
brew commands → verification and first scan.


## Difference with Kubernetes VPA

| Feature 🛠️ | Robusta KRR 🚀 | Kubernetes VPA 🌐 |
Expand Down