docs: rework README with examples and better readability #121
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR reworks the README to improve clarity and usability by adding comprehensive examples and better explaining how React Native Brownfield enables integration between React Native and native apps. The changes focus on making the documentation more accessible to developers looking to implement brownfield React Native integration.
- Enhanced the introduction and features section with clearer language and better formatting
- Added detailed usage examples for both iOS (SwiftUI) and Android (Kotlin) implementations
- Reorganized content structure to prioritize practical examples over language-specific documentation links
README.md
Outdated
Comment on lines
22
to
23
| > [!TIP] | ||
| > Download a free copy of an ebook that goes step-by-step through [incremental React Native adoption in native apps](https://www.callstack.com/ebooks/incremental-react-native-adoption-in-native-apps?utm_campaign=brownfield&utm_source=github&utm_medium=referral&utm_content=react-native-brownfield). |
There was a problem hiding this comment.
Maybe we could get an ebook banner? This can be easily missed
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated README so it puts clear emphasis on how React Native Brownfield works across React Native and native apps, with simple examples for both iOS and Android, and linking to more advanced docs
Test plan