Improve README

[simonecorsi]

Summary

• update README with a more detailed guide for users and contributors

Testing

• npm test

---

https://chatgpt.com/codex/tasks/task_e_68400fd1eb80832c9c68a6f57a60bab6

Summary by CodeRabbit

• Documentation
  • Improved clarity, formatting, and structure of the README.
  • Updated Table of Contents and reorganized sections.
  • Added new "API" and "Development" sections.
  • Enhanced usage examples and clarified contribution guidelines.
  • Fixed minor typographical and formatting issues throughout.

[coderabbitai]

Walkthrough

The README file was updated for improved clarity, organization, and formatting. Content was reworded for readability, new sections on API and development were added, usage examples were corrected, and contribution guidelines were clarified. Minor typographical and formatting fixes were also applied throughout the document.

Changes

File(s)	Change Summary
README.md	Revised for clarity, reorganized content, updated usage examples, added API and development sections, clarified contribution guidelines, and applied formatting and typographical fixes.

Poem

In README fields where clarity blooms,
New sections grow and old resume.
With words aligned and structure neat,
Usage and guides now feel complete.
The rabbit hops with tidy cheer—
Documentation’s crystal clear!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16aceff and d5ca386.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

9-9: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

---

10-10: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

🔇 Additional comments (11)

README.md (11)

3-3: Reworded tagline effectively conveys benefits.

The updated intro succinctly highlights the zero-dependency advantage and performance gains.

---

13-14: Updated TOC with API and Valid Operators sections.

Including these entries improves discoverability of key documentation sections.

---

16-16: Added Development section to TOC.

This ensures readers can quickly find build and test instructions.

---

23-23: Enhanced About section with engaging intro.

The conversational tone makes the motivation clearer and more relatable.

---

27-28: Benefits section formatting improved.

Swapping to dashes improves consistency with other lists.

---

32-34: Use Cases section refined for clarity.

The bullet points now clearly outline environments for query validation.

---

47-56: Corrected usage examples with proper import and variable names.

The snippet now accurately reflects the package import and demonstrates variable renaming for clarity.

---

59-71: Detailed API section added.

The function signature, parameter descriptions, and return values are clearly documented and linked to type definitions.

---

75-75: Valid query operators section updated with direct link.

Pointing to the source file makes operator reference quick and reliable.

---

79-86: Contributing guidelines clarified with stepwise instructions.

The numbered workflow and Conventional Commits emphasis will help onboard contributors effectively.

---

89-92: Development section detailing build, test, and coverage.

Providing CLI commands here is very helpful for contributors and maintainers.

---

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

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