Update README.md for grammar

[apokusin]

Summary by CodeRabbit

• Documentation
  • Improved phrasing, punctuation, and spelling throughout the README for better clarity and readability. No changes to functionality or instructions.

[mentatbot]

If you would like me to review this PR, either tag me in a comment or check this box:

• Review PR

_{You can disable automatic comments on my settings page}

[coderabbitai]

Walkthrough

The changes made are limited to the README.md file and consist solely of textual corrections. These include fixing spelling errors, improving phrasing, adjusting punctuation, correcting hyphenation in compound adjectives, and refining sentence structure for clarity. No content, instructions, or structural elements were altered, and there were no modifications to any code, functionality, or exported/public entities.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇
With commas and dashes, I hop through the text,
Fixing each typo, so no one is vexed.
A sprinkle of clarity, a dash of delight,
Now the README shines, polished and bright!

—Rabbit with a red pen

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/readme-grammar

---

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

32-32: Unify spelling of “anonymizer” across the doc

Line 32 uses the US spelling “anonymizer”, while Line 47 reverts to the UK spelling “Anonymiser”. Pick one variant and stick to it for consistency (the rest of the README leans toward US spelling).

Also applies to: 47-47

---

173-174: Add missing colon after the heading sentence

“Steps to update the schema” reads like a heading but ends without punctuation. Append a colon or convert it to a proper heading (###) so the subsequent numbered list is clearly introduced.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b70cfa2 and bd8638d.

📒 Files selected for processing (1)

• README.md (6 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~47-~47: Ensure spelling is correct
Context: ...n in a trusted execution environment. - Anonymiser model is running locally on the user's ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (1)

README.md (1)

1-190: README edits look good overall

All other textual tweaks tighten phrasing and correct earlier grammar issues without altering meaning. No further action required.