Skip to content

Commit 9ce7907

Browse files
authored
feat: update new apis, reword docs (#101)
* feat: update new apis, reword docs * docs: mention new architecture
1 parent 676d1cf commit 9ce7907

File tree

5 files changed

+212
-396
lines changed

5 files changed

+212
-396
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@
2323

2424
- **Easily integrate** React Native with existing native app
2525
- Start React Native with **one method** and invoke code as soon as it's loaded
26-
- Reuse the same instance of React Native **bridge** between different components
26+
- Compatible with **both old and new React Native architecture**!
27+
- Reuse the same instance of React Native between different components
2728
- Use predefined **native building blocks** - crafted for React Native
2829
- Disable and enable **native gestures and hardware buttons** from JavaScript
2930
- Works well with **any native navigation** pattern, as well as every React Native JavaScript based navigation
3031
- Compatible with all native languages **Objective-C**, **Swift**, **Java** and **Kotlin**
32+
- Supports UIKit and SwiftUI on iOS and Fragments and Jetpack Compose on Android
3133

3234

3335
## Installation
@@ -42,6 +44,26 @@ or
4244
yarn add @callstack/react-native-brownfield
4345
```
4446

47+
## Enabling New Architecture
48+
49+
### Android
50+
Add the following to your `android/gradle.properties`:
51+
52+
```
53+
# Enable new architecture
54+
newArchEnabled=true
55+
```
56+
57+
### iOS
58+
Install cocoapods with the flag:
59+
60+
```
61+
RCT_NEW_ARCH_ENABLED=1 pod install
62+
```
63+
64+
> [!NOTE]
65+
> New Architecture is enabled by default from React Native 0.76
66+
4567
## Usage
4668

4769
React Native Brownfield library works with all major native programming languages. Majority of its API is exposed on the native side. Click on the logo to choose the one that interests you:
@@ -79,6 +101,7 @@ ReactNativeBrownfield.popToNative(true);
79101

80102
> NOTE: Those methods works only with native components provided by this library.
81103
104+
82105
## Made with ❤️ at Callstack
83106

84107
React Native Brownfield is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack](https://callstack.com) is a group of React and React Native geeks, contact us at [[email protected]](mailto:[email protected]) if you need any help with these or just want to say hi!

0 commit comments

Comments
 (0)