docs: add Quick Start Guide section to README

[vincent067]

Hi there! 👋

This PR adds a Quick Start Guide section to the README to help new users get started with KRR more quickly.

Changes:

• Added a concise Quick Start Guide section right after the project overview
• Includes 3 simple steps: install, verify, and run
• Helps users get up and running in under 5 minutes

I hope this helps make the project more accessible to new users! 😊

Please let me know if you would like any adjustments.

Thanks for maintaining this awesome project! 🙏

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

Alex Chen seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

The README now includes a "Quick Start Guide" section documenting installation and setup instructions via both pip and Homebrew package managers, demonstrating how to install KRR, verify the installation, and run an initial scan.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added "Quick Start Guide" section with two installation flows: pip-based installation with Prometheus URL verification, and Homebrew-based installation with simple scan execution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• arikalon1
• aantn

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely describes the main change: adding a Quick Start Guide section to the README documentation.
Description check	✅ Passed	The description clearly explains the change, listing specific improvements (three steps: install, verify, run) and the intended benefit for new users.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 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.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 36b69c72-7d14-4d30-90d7-df2aa1cfd2ed

📥 Commits

Reviewing files that changed from the base of the PR and between c40fe37 and a5ef569.

📒 Files selected for processing (1)

• README.md

[coderabbitai]

⚠️ 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.