Improve README installation and usage guidance

[somework]

Summary

• update badges and installation section to reflect composer usage
• expand README usage example to clarify page/size results and exception behavior
• document how to run tests, static analysis, and coding standards checks

Testing

• composer test

---

Codex Task

Summary by CodeRabbit

• Documentation
  • Updated package description and installation/usage examples for improved clarity
  • Enhanced code samples demonstrating public API usage
  • Added explicit exception behavior documentation for scenarios exceeding available records
  • Minor textual refinements throughout

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@somework has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ef9cd60 and e27fd7f.

📒 Files selected for processing (1)

• README.md (1 hunks)

Walkthrough

README.md updated with revised package description, installation and usage examples, code samples demonstrating public API usage, and added exception behavior documentation. Badge section renamed and minor textual refinements applied throughout.

Changes

Cohort / File(s)	Change Summary
Documentation Updates README.md	Renamed badge section; revised package description; updated installation and usage examples; modified code samples to demonstrate public API usage (Offset::logic); added exception behavior note for exceeding available records; minor textual refinements

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• No code changes or logic modifications requiring functional verification
• Documentation-only updates with straightforward example corrections
• Minimal context needed beyond reading the markdown file

Poem

🐰✨ The README hops with fresher words today,
Examples dance in their cleaner way,
Badges shine bright, exceptions now clear,
Our public API shines ever dear! 📚🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Improve README installation and usage guidance' directly aligns with the PR objectives, which focus on updating installation guidance, expanding usage examples, and improving documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

3-4: Fix capitalization and bare URL formatting.

Line 3: The official name should be capitalized as "GitHub" (not "Github").
Line 4: The email should be enclosed in angle brackets for proper markdown formatting.

Apply this diff:

-Author: [Igor Pinchuk](https://github.com/somework "Github") Email: i.pinchuk.work@gmail.com
+Author: [Igor Pinchuk](https://github.com/somework "GitHub") Email: <i.pinchuk.work@gmail.com>

---

63-66: Use atx-style heading for consistency.

The License section uses setext-style heading (underline with dashes), which is inconsistent with the atx-style headings (##, ###) used throughout the rest of the document.

Apply this diff:

-License
-----

+## License

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1cf25b and ef9cd60.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~3-~3: The official name of this software platform is spelled with a capital “H”.
Context: ...Offset Page Logic Author: Igor Pinchuk Email: i.pinchuk.work@gmail.com [![C...

(GITHUB)

🪛 markdownlint-cli2 (0.18.1)

README.md

4-4: Bare URL used

(MD034, no-bare-urls)

---

63-63: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

🔇 Additional comments (3)

README.md (3)

6-18: Installation and badge updates look good.

The CI badge is properly formatted, and the installation section clearly documents the Composer workflow. Both changes appropriately reflect the package management approach.

---

20-50: Usage and exception behavior documentation is well-structured.

The usage section effectively demonstrates the API with concrete inputs and expected outputs. The exception behavior section appropriately shows when AlreadyGetNeededCountException is thrown, providing developers with clear guidance on expected behavior. Both sections align with the PR objectives and improve the developer experience.

---

52-61: Development section clearly documents test and analysis commands.

The new Development section provides helpful guidance on running the test suite, static analysis, and coding standards checks via Composer scripts. This directly addresses the PR objective and aids contributor workflows.