Skip to content

docs: refresh README - #14

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

roxblnfk merged 1 commit into
1.xfrom
docs/readme

Conversation

@roxblnfk

@roxblnfk roxblnfk commented Oct 9, 2026 •

Copy link
Copy Markdown
Member
Q A
Bugfix? ❌
Breaks BC? ❌
New feature? ❌
Issues —
  • New header: centered RoadRunner logo, tagline, Documentation / Sponsor badges, then Psalm level / type coverage badges from Shepherd, and a short intro linking the Lock plugin docs.
  • ## Get Started groups Requirements, Installation (with packagist badges), a minimal .rr.yaml and a first lock example; the existing method docs follow under ## Usage. The License section is removed.
  • Dropped the Codecov badge (the last upload is from July 2024, the shared phpunit workflow gets no CODECOV_TOKEN), workflow status badges and the Discord badge.
  • "Check lock" now matches the API: exists() returns bool and takes an optional lock id; the updateTTL() example says it sets the TTL (the plugin replaces it) instead of adding to it.

The Requirements list is untouched, so this merges cleanly with #10.

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: cdc8afc8-b526-434c-a31f-ca3cb1496c26

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

@roxblnfk
roxblnfk merged commit a5190d3 into 1.x Oct 9, 2026
6 of 12 checks passed
@roxblnfk
roxblnfk deleted the docs/readme branch October 9, 2026 18:09
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