[fazi-gondal]

Summary

Improve the README to make react-native-codepad easier to understand, integrate, and use.

Changes

• Add installation requirements and native rebuild instructions.
• Expand the usage example with editor configuration and event handling.
• Document supported languages and language discovery.
• Add reference tables for props and methods, with accurate defaults and callback types.
• Clarify important API behavior, including initialValue, change events, text offsets, selection ranges, and regular expression replacements.
• Add guidance for keyboard handling and scrolling.
• Improve links to the API reference, guides, roadmap, contributing guidelines, and license.

Purpose

Make the README a more reliable starting point for developers while keeping detailed documentation available through the existing reference pages.

Scope: Documentation only. No runtime code changes are intended.

Summary by CodeRabbit

• Documentation
  • Clarified when native apps need to be rebuilt and how the editor must be positioned in its layout.
  • Added guidance on installing language support, configuring language identifiers, and checking available languages.
  • Expanded API guidance for editor options, callbacks, methods, initialization, offsets, ranges, and search behavior.
  • Added keyboard and scrolling documentation and links to detailed references.

[coderabbitai]

Important

• 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 54b19175-fa4c-402c-a7a0-4b0d85a4d40b

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 40f0c6dc-7070-46c7-a451-ac11771beb98

Commits

Reviewing files that changed from the base of the PR and between 74c3732 and 49a0f61.

Files selected for processing: 1

• README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The README adds native rebuild and layout guidance, language support instructions, expanded prop and method descriptions, and guidance on editor behavior, keyboard use, and scrolling.

Changes: README Documentation

Layer / File(s)	Summary
Setup and language support README.md	Adds native rebuild guidance, a parent-layout requirement, language-package instructions, and a runtime query for available languages.
API reference and behavior README.md	Expands prop and method descriptions. Adds guidance on initialization, callbacks, offsets, ranges, search, keyboard use, and scrolling.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested reviewers: sectiontn

Merge Risk: Minimal · up to 49a0f

The README updates are mergeable with no identified runtime or integration risk.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly describes the README documentation changes, including the expanded API reference and usage examples.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.}

[SectionTN]

Thanks @fazi-gondal. Every prop, method and default you added matches the code. The README stays short and links to the docs site for details, so I pushed one commit that keeps your new props and methods rows and drops the extra sections.

[fazi-gondal]

Ok @SectionTN no problem and thanks