Skip to content

docs: refresh the README - #53

Merged
roxblnfk merged 1 commit into
2.xfrom
docs/readme
Oct 9, 2026
Merged

roxblnfk merged 1 commit into
2.xfrom
docs/readme

Conversation

@roxblnfk

@roxblnfk roxblnfk commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

🔍 What was changed

  • New header: RoadRunner logo, tagline, Documentation and Sponsor badges, Psalm level and type coverage from shepherd; the badges of the Go server repository (spiral/roadrunner, scrutinizer, goreportcard, godoc) are gone.
  • ## Get Started with Installation (composer require spiral/roadrunner-cli and Packagist badges) and a short "get the binary and run it" walkthrough; the License and Testing sections are removed.
  • Command docs kept and brought in line with src/: the make-config command, --no-config, the otel plugin, the shared binary options and GITHUB_TOKEN are now covered; running without --plugin/--preset generates the default plugin set, not a complete config.

Checklist

  • How was this tested:
    • Commands and options checked against vendor/bin/rr <command> --help

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 52 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 35b7e6db-593d-405f-b2fd-f7c31d5e9969

📥 Commits

Reviewing files that changed from the base of the PR and between 54909d3 and e21133c.


📒 Files selected for processing (1)
  • README.md


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

The old header carried badges of the Go server repository (spiral/roadrunner), and the testing note pointed to a host repository that does not test this package.

Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
@roxblnfk
roxblnfk merged commit 623354c into 2.x Oct 9, 2026
1 of 2 checks passed
@roxblnfk
roxblnfk deleted the docs/readme branch October 9, 2026 18:07
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.

1 participant