Update readme

[msmakouz]

Q	A
Bugfix?	❌
Breaks BC?	❌
New feature?	❌

[coderabbitai]

Walkthrough

The recent update brings a notable enhancement to our project's infrastructure. It mandates the use of PHP version 8.1 or newer, ensuring our codebase leverages the latest language features and performance improvements. Additionally, it recommends installing the ext-protobuf extension to boost performance further. Lastly, it aligns our project with RoadRunner version ^2023.3, optimizing compatibility and efficiency. These changes collectively aim to modernize our environment and improve overall application performance.

Changes

File(s)	Change Summary
README.md	- Updated PHP version requirement to >=8.1 - Recommended ext-protobuf extension for better performance - Specified RoadRunner version as ^2023.3

🐇✨

In the fields of code, under the digital sun,
A leap to PHP 8.1, our journey has begun.
With ext-protobuf's grace, our code takes flight,
And RoadRunner guides us, through the night.
Here's to the changes, may they make our code run light!
🚀🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e824157 and 736523b.

Files selected for processing (1)

• README.md (1 hunks)

Additional Context Used

Additional comments not posted (3)

README.md (3)

38-38: The PHP version requirement has been updated to >=8.1. This change aligns with the PR objectives and ensures users are aware of the minimum PHP version needed. It's crucial to verify that all features used in the project are compatible with PHP 8.1 and above.

---

39-40: The recommendation to install the ext-protobuf extension is well-placed and clearly communicates the potential performance benefits. However, it might be helpful to include a brief explanation or link to more information on how ext-protobuf enhances performance, especially for users unfamiliar with protocol buffers.

---

41-41: Specifying the required RoadRunner version as ^2023.3 is essential for ensuring compatibility and leveraging specific features or optimizations introduced in this version. This update is in line with the PR objectives.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.55%. Comparing base (e824157) to head (736523b).

Additional details and impacted files

@@            Coverage Diff            @@
##                3.x      #25   +/-   ##
=========================================
  Coverage     53.55%   53.55%           
  Complexity       72       72           
=========================================
  Files             4        4           
  Lines           211      211           
=========================================
  Hits            113      113           
  Misses           98       98           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.