Restructure and extend the README

[nezhar]

Improves the README.md to make the project easier to understand and more appealing to new users. The updates add a comprehensive feature overview, clearer installation and quick start instructions, and detailed information about the analytics dashboard. The documentation now better communicates the project's value and how to get started.

Key documentation improvements:

Feature highlights and usability:

• Added a "Features" section summarizing key benefits such as zero configuration, agent isolation, unified CLI, local analytics dashboard, privacy, and simple installation.
• Enhanced the project description to emphasize ease of use, local metrics, and agent comparison capabilities.

Getting started:

• Added a "Quick Start" section with example commands to help users run agents immediately after installation.

Analytics and dashboard:

• Introduced a new section explaining local metrics collection and the analytics dashboard, including a table of relevant commands and a preview image.

Summary by CodeRabbit

• Documentation
  • Expanded README with branding, reworded project description, new Features, Quick Start, Analytics & Dashboard, image namespace and override guidance, and formatting/reorganization updates.
• Chores
  • Added Python package classifiers to project metadata (updated supported Python versions).

[coderabbitai]

Warning

Rate limit exceeded

@nezhar has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b28b80f1-087b-4f9d-a6e5-a8fa8e836724

📥 Commits

Reviewing files that changed from the base of the PR and between 8f3d55c and 2ffbe85.

⛔ Files ignored due to path filters (1)

• docs/assets/dashboard.png is excluded by !**/*.png

📒 Files selected for processing (2)

• README.md
• pyproject.toml

📝 Walkthrough

Walkthrough

Expanded project documentation (README) with branding, features, quick-start, analytics/dashboard, image namespace and override guidance; added Python classifiers to pyproject.toml metadata. No public API, code, or behavior changes.

Changes

Cohort / File(s)	Summary
Documentation README.md	Large expansion and reorganization: added license badge, reworded description, Features, Quick Start examples, Analytics & Dashboard section (commands, metrics table), expanded Image Namespace and Overriding Images details, formatting adjustments.
Project Metadata pyproject.toml	Added Python version classifiers under [project] (3, 3.10–3.14). Metadata-only change, no dependency or build/script edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Add documentation for usage of custom container builds #22: Related to documentation about customizing/overriding agent container images (overlapping image override guidance).
• Add cli preview in readme and docs #24: Also modifies README content and CLI-related docs (overlap in README edits and visuals).

Poem

🐇✨ The README grows with clearer light,
Features, dashboards, quick-starts in sight.
Images mapped and overrides named,
Classifiers added, the project's framed.
Hop, dear reader — the docs feel right!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Restructure and extend the README' accurately describes the main changes in the pull request, which involve reorganizing and significantly expanding the README.md documentation.
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
• Post copyable unit tests in a comment
• Commit unit tests in branch extend-docs

📝 Coding Plan

• Generate coding plan for human review comments

---

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.}

[greptile-apps]

Greptile Summary

This PR restructures and expands the README.md to improve onboarding clarity, adding a Features overview, Quick Start section, and a dedicated Analytics & Dashboard section (backed by a new docs/assets/dashboard.png screenshot). It also adds Python version classifiers to pyproject.toml.

Key changes:

• Features section — concisely summarises zero-config, agent isolation, unified CLI, local analytics, privacy, and install simplicity.
• Quick Start section — provides runnable example commands immediately after installation.
• Analytics & Dashboard section — explains local metrics collection, adds a command reference table for vp logs, and includes the new dashboard screenshot.
• vp logs reorganisation — the commands were removed from the flat "Current Status" list and documented in context under the new Analytics section, which is a cleaner structure.
• pyproject.toml classifiers — Python 3.10–3.14 trove classifiers are added; standard License and Operating System classifiers are absent (see inline comment).

Confidence Score: 5/5

• This PR is safe to merge — changes are limited to documentation and package metadata with no functional code modifications.
• All changes are documentation (README restructure + dashboard screenshot) and non-breaking PyPI metadata (classifiers). The only minor issue is missing standard license/OS classifiers in pyproject.toml, which has no runtime impact.
• pyproject.toml — consider adding standard license and OS classifiers alongside the new Python version classifiers.

Important Files Changed

Filename	Overview
README.md	Documentation restructure — adds Features, Quick Start, and Analytics & Dashboard sections, moves preview image, and cleans up the Current Status list. Content is accurate and consistent with the codebase.
pyproject.toml	Adds Python 3.10–3.14 version classifiers; missing "License :: OSI Approved :: MIT License" and "Operating System :: OS Independent" classifiers that are standard PyPI convention.
docs/assets/dashboard.png	New binary asset — analytics dashboard screenshot added to back the new Analytics & Dashboard section in the README.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([User]) -->|vp run claude / codex / gemini / ...| B[Docker Container\nper agent]
    B -->|HTTP traffic| C[(Local Metrics Store)]
    B -->|Token usage| C
    A -->|vp logs start| D[Dashboard Container\nvibepod/datasette]
    C --> D
    D -->|Per-agent HTTP traffic\nUsage over time\nToken metrics| E([Browser Dashboard])
    D -->|Side-by-side comparison| E

    style B fill:#2496ED,color:#fff
    style D fill:#2496ED,color:#fff
    style C fill:#4CAF50,color:#fff
    style E fill:#9C27B0,color:#fff

Loading

_{Last reviewed commit: 2ffbe85}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)

19-19: Consider adding OpenCode to the agent list.

The Features section lists "Claude, Gemini, Codex, Devstral, Copilot, Auggie" but OpenCode is also available according to the Image Namespace section (line 81). Consider adding OpenCode to this list for completeness.

🤖 Prompt for AI Agents

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

In `@README.md` at line 19, Update the Features line that currently reads "🔀
**Unified interface** — one CLI for Claude, Gemini, Codex, Devstral, Copilot,
Auggie & more" to include OpenCode; locate the string in README.md (the Features
section) and append "OpenCode" to the list so it reads similarly to the other
agents and matches the Image Namespace section that references OpenCode.

🤖 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`:
- Line 65: Update the README entry for the `vp logs start` command to clarify
the wording: replace "Start/reuse dashboard for collected metrics" with a
clearer phrase such as "Start or resume dashboard for collected metrics" (or
"Start/resume dashboard for collected metrics") so the intent of reusing an
existing dashboard is explicit; update the line that contains `vp logs start`
accordingly.

---

Nitpick comments:
In `@README.md`:
- Line 19: Update the Features line that currently reads "🔀 **Unified
interface** — one CLI for Claude, Gemini, Codex, Devstral, Copilot, Auggie &
more" to include OpenCode; locate the string in README.md (the Features section)
and append "OpenCode" to the list so it reads similarly to the other agents and
matches the Image Namespace section that references OpenCode.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 18433486-dbb2-4221-9714-0699baeb668d

📥 Commits

Reviewing files that changed from the base of the PR and between b5c0af6 and 41b674b.

⛔ Files ignored due to path filters (1)

• docs/assets/dashboard.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md