Skip to content

docs: add version requirements to installation section#157

Open
thomasttvo wants to merge 1 commit intomasterfrom
docs/add-version-requirements
Open

docs: add version requirements to installation section#157
thomasttvo wants to merge 1 commit intomasterfrom
docs/add-version-requirements

Conversation

@thomasttvo
Copy link
Copy Markdown
Collaborator

@thomasttvo thomasttvo commented Jan 2, 2026

Summary

  • Adds React Native >= 0.79.0 and React >= 16.8.0 requirements to README Installation section

Context

PR #148 upgraded the example app to React Native 0.79, which updated the peerDependencies. This PR documents those requirements in the README for users.

Changes

  • Added Requirements section to Installation with version constraints

🤖 Generated with Claude Code


Note

Introduces automated release notes and updates user-facing docs, alongside a refreshed build.

  • Add .github/release.yml to configure changelog categories, and exclude specific labels/authors
  • Update CONTRIBUTING.md with label guidance for release notes
  • Update README.md with a Changelog link and Installation requirements (React Native >= 0.79.0, React >= 16.8.0)
  • Regenerate lib/commonjs/** with modern runtime/optional chaining and minor responder handling cleanups

Written by Cursor Bugbot for commit 78814ce. Configure here.

@thomasttvo thomasttvo added the documentation Improvements or additions to documentation label Jan 2, 2026
@thomasttvo thomasttvo force-pushed the docs/add-version-requirements branch 3 times, most recently from db6dafb to 795a1f9 Compare January 2, 2026 18:41
@thomasttvo thomasttvo force-pushed the docs/add-version-requirements branch from 795a1f9 to f2e9051 Compare January 2, 2026 18:46
@thomasttvo
Copy link
Copy Markdown
Collaborator Author

@claude please review this PR

@thomasttvo
Copy link
Copy Markdown
Collaborator Author

@claude review

Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — simple documentation addition with no code changes.

Extended reasoning...

Overview

This PR modifies only README.md, adding a 4-line Requirements section to the Installation instructions listing React Native >= 0.79.0 and React >= 16.8.0. No source code, tests, or configuration files are changed.

Security Risks

None — this is a purely documentation change.

Level of Scrutiny

Minimal scrutiny needed. The version numbers align with PR #148 which upgraded the example app to React Native 0.79 and updated peerDependencies accordingly. The change is factually consistent with the existing package.json peerDependencies.

Other Factors

No bugs were found by the automated review system. The change is a trivial, mechanical doc update that clearly follows an established pattern (documenting requirements near the install instructions). Safe to approve without human review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant