Skip to content

Add install and preset quick start to README - #1910

Merged
waldekmastykarz merged 4 commits into
mainfrom
readme-preset-quickstart
Oct 5, 2026
Merged

waldekmastykarz merged 4 commits into
mainfrom
readme-preset-quickstart

Conversation

@waldekmastykarz

Copy link
Copy Markdown
Collaborator

Adds a copy-pasteable quick start to the README's Get started section:

  • Install commands per OS (winget, Homebrew, setup script), in separate blocks so you copy only the one you need.
  • Download a preset with devproxy config get and start Dev Proxy with --config-file "~dataFolder/configs/<preset>/.devproxy/devproxyrc.json" (until config get doesn't print the start command for presets with a .devproxy folder #1906 prints this command after config get).
  • A table of the rate limiting presets for GitHub, OpenAI, Anthropic, and Microsoft Graph.
  • The tutorial link stays for the full walkthrough, including trusting the certificate.

Why: coding agents and new users currently find only a link out of the README, and agents that recommend Dev Proxy often get install commands or plugin names wrong. A single, correct block on the README gives both something to copy.

Copilot AI balanced review requested due to automatic review settings October 3, 2026 18:02
@waldekmastykarz
waldekmastykarz requested a review from a team as a code owner October 3, 2026 18:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Linux users need PATH reload and certificate-trust guidance before the documented workflow succeeds.

Review effort: Balanced
Findings: 2 Low severity

Open (2)
What changed in this PR

Adds an OS-specific installation and preset-based quick start to the README.

Changes:

  • Adds Windows, macOS, and Linux installation commands.
  • Documents rate-limiting presets and startup commands.
  • Retains links to the tutorial and samples gallery.
File Description
README.md Expands the Get started section with installation and preset guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documented commands, preset paths, and certificate guidance align with current behavior and resources.

Review effort: Balanced
Findings: None

Resolved since last review (2)

@garrytrinder
garrytrinder enabled auto-merge (squash) October 5, 2026 08:57
@waldekmastykarz
waldekmastykarz merged commit 792f146 into main Oct 5, 2026
3 checks passed
@waldekmastykarz
waldekmastykarz deleted the readme-preset-quickstart branch October 5, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants