Skip to content

Commit f4bb765

Browse files
committed
docs: add note about new runtime
1 parent 3a474ab commit f4bb765

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@
66

77
![Rive hero image](https://rive-app.notion.site/image/https%3A%2F%2Fs3-us-west-2.amazonaws.com%2Fsecure.notion-static.com%2Fff44ed5f-1eea-4154-81ef-84547e61c3fd%2Frive_notion.png?table=block&id=f198cab2-c0bc-4ce8-970c-42220379bcf3&spaceId=9c949665-9ad9-445f-b9c4-5ee204f8b60c&width=2000&userId=&cache=v2)
88

9+
> **🚀 New Runtime Available for Testing!**
10+
>
11+
> We're excited to announce that the new Rive React Native runtime is now public and ready for testing. Built with Nitro for improved performance and better React Native integration, this next-generation runtime leverages the new React Native architecture and will eventually be distributed on NPM under the name `@rive-app/react-native`.
12+
>
13+
> **Try it now:** https://github.com/rive-app/rive-nitro-react-native
14+
>
15+
> **Current Status:** The new package is in development preview. While it's functional and actively maintained, the API may change in future releases. We recommend testing thoroughly before using in production applications.
16+
>
17+
> **Migration Timeline:**
18+
>
19+
> - **Short term:** Complete the new runtime and unblock production usage
20+
> - **Medium term:** Address major concerns in this legacy package while supporting migration
21+
> - **Long term:** Full migration to the new package
22+
>
23+
> We're actively gathering feedback to improve the new runtime. Please share your thoughts and report any issues you encounter!
24+
925
A React Native runtime library for [Rive](https://rive.app).
1026

1127
This library is a wrapper around the iOS/Android runtime, providing a component and ref pattern for React Native applications.
@@ -58,11 +74,13 @@ Check out the `example/` folder to run an example application using the Rive Rea
5874
- ...and more!
5975

6076
Steps:
77+
6178
1. Run `yarn bootstrap`
6279
2. cd `example`
6380
3. `yarn expo run:android` or `yarn expo run:ios`
6481

6582
iOS:
83+
6684
- You may need to run `pod install` (first time) or `pod update RiveRuntime` (updates to the underlying Rive iOS runtime) in the `example/iOS` folder to get the runtime installed or updated
6785

6886
## Migration Guides
@@ -114,6 +132,7 @@ Create or edit `ios/Podfile.properties.json`:
114132
```
115133

116134
Then run:
135+
117136
```bash
118137
cd ios && pod install
119138
```
@@ -159,9 +178,11 @@ export default ({ config }: ConfigContext): ExpoConfig => ({
159178
The library resolves versions in the following order:
160179

161180
**iOS:**
181+
162182
1. `ios/Podfile.properties.json``RiveRuntimeIOSVersion`
163183
2. `package.json``runtimeVersions.ios` (default)
164184

165185
**Android:**
186+
166187
1. `android/gradle.properties``Rive_RiveRuntimeAndroidVersion`
167188
2. `package.json``runtimeVersions.android` (default)

0 commit comments

Comments
 (0)