Skip to content

docs: update README with testing and compatibility notes#5

Merged
eajr merged 1 commit into
mainfrom
codex/docs-readme-updates
Feb 11, 2026
Merged

docs: update README with testing and compatibility notes#5
eajr merged 1 commit into
mainfrom
codex/docs-readme-updates

Conversation

@eajr
Copy link
Copy Markdown
Owner

@eajr eajr commented Feb 11, 2026

Summary by CodeRabbit

  • Documentation
    • Added testing section with CI behavior guidance
    • Updated public API reference
    • Added lifecycle hook compatibility notes across Elysia versions and adapters

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 11, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation updates to README.md including a Testing section with bun test instructions, renaming of the Options interface to IOptions in the public API reference, and compatibility notes for onAfterResponse and onResponse lifecycle hooks.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added Testing section with bun test instructions. Updated public API reference to rename export interface Options to export interface IOptions. Added compatibility documentation for onAfterResponse and onResponse lifecycle hooks across Elysia versions and adapters.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A README grows with wisdom new,
Interface names now crystal-clear in view,
Testing paths and hooks aligned,
Documentation refined, purpose defined! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/docs-readme-updates

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

@eajr eajr merged commit 979ba66 into main Feb 11, 2026
1 of 2 checks passed
@eajr eajr deleted the codex/docs-readme-updates branch February 11, 2026 16:58
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