docs(readme): add configuration scenario examples

[feloy]

Add three new scenarios under the Scenarios section to document common real-world configurations:

• Claude with a model from Vertex AI (CLAUDE_CODE_USE_VERTEX, credentials mount, optional Claude settings sharing)
• Sharing a GitHub token globally or per project via projects.json, including .gitconfig mount and Podman secret creation
• Working with git worktrees to run parallel agents on different branches, with per-user main branch mount via projects.json

Closes #132

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[coderabbitai]

Warning

Rate limit exceeded

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

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 11 minutes and 51 seconds.

⌛ 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ad81fe9f-dcd6-406b-9fa4-33613595943e

📥 Commits

Reviewing files that changed from the base of the PR and between 8607392 and fe077a9.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

Added three new scenario subsections to README.md documenting configuration patterns for: Claude with Model from Vertex AI, sharing GitHub tokens via credential mounting, and working with Git worktrees. Includes example configuration files and operational commands for each scenario.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added three new "Scenarios" subsections with configuration examples for Vertex AI models, GitHub token sharing, and Git worktree workflows, including example agents.json, projects.json, and command usage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• #1 — Adds initial README.md; this PR extends it with scenario-specific configuration examples.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding configuration scenario examples to the README documentation.
Description check	✅ Passed	The description clearly details the three new scenarios added and references the related issue, directly relating to the changeset.
Linked Issues check	✅ Passed	All three requirements from issue #132 are addressed: Vertex AI configuration, GitHub token/config sharing, and git worktrees workflow documentation.
Out of Scope Changes check	✅ Passed	Changes are limited to README.md documentation additions directly aligned with the three scenarios specified in issue #132.
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.}

---

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`:
- Line 272: The example command shows an unsupported -v flag; update the README
example to remove -v and use supported flags (e.g., change "kortex-cli list -o
json -v" to "kortex-cli list -o json" or the equivalent "kortex-cli workspace
list --output=json"), and update the surrounding text to reference only the
supported flags (--output and --storage) so users can reliably find the project
field.

🪄 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: a1c9eb80-40dc-41f7-9823-0ce9fa72fc91

📥 Commits

Reviewing files that changed from the base of the PR and between 545a0ea and 8607392.

📒 Files selected for processing (1)

• README.md