Skip to content

Commit 470be26

Browse files
committed
docs: update docs
1 parent 69b6497 commit 470be26

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

docs/docs/docs/getting-started/introduction.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ React Native Brownfield is a library that simplifies integrating React Native in
1010
- Reuse the same instance of React Native between different components
1111
- Use predefined **native building blocks** - crafted for React Native
1212
- Disable and enable **native gestures and hardware buttons** from JavaScript
13+
- Compatible with **Expo**
1314
- Works well with **any native navigation** pattern, as well as any React Native JavaScript-based navigation
1415
- Compatible with all native languages **Objective-C**, **Swift**, **Java** and **Kotlin**
1516
- Supports UIKit and SwiftUI on iOS and Fragments and Jetpack Compose on Android

docs/docs/docs/getting-started/quick-start.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,31 @@ For best experience, you can use the built-in `brownfield` CLI that comes with t
3838

3939
Follow [the CLI documentation here](/docs/cli/introduction) to see how to use it.
4040

41+
#### For Expo apps
42+
43+
For Expo apps, the CLI is the preferred way to package your React Native app as an XCFramework or Fat-AAR. Additionally, `@callstack/react-native-brownfield` ships an Expo plugin that you need to configure in your `app.json` file:
44+
45+
```json
46+
{
47+
"plugins": [
48+
[
49+
"@callstack/react-native-brownfield",
50+
{
51+
"ios": {
52+
"frameworkName": "BrownfieldExpoApp"
53+
},
54+
"android": {
55+
"moduleName": "brownfield-expo-app"
56+
},
57+
"debug": true
58+
}
59+
]
60+
]
61+
}
62+
```
63+
64+
Then, follow [the CLI documentation here](/docs/cli/introduction) to see how to package the application.
65+
4166
#### With Rock
4267

4368
It is very likely you will find Rock the easiest way to use brownfield in your React Native project. Rock provides for instance a clean template with `@callstack/react-native-brownfield` already integrated so you can easily bootstrap a new, clean brownfield project with zero manual configuration required. Below you will find instructions both for bootstrapping a new brownfield project and integrating your existing React Native app with Rock.

0 commit comments

Comments
 (0)