Skip to content

Commit da866e9

Browse files
authored
Add table of additional dependency packages (#385)
Add table of additional dependency packages and update readme titles.
1 parent 21fb939 commit da866e9

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

Modules/@babylonjs/react-native-iosandroid/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @babylonjs/react-native-iosandroid
1+
# Babylon React Native iOS and Android Runtime
22

33
## Usage
44

@@ -9,4 +9,4 @@ This package contains iOS and Android dependencies for @babylonjs/react-native.
99
This package has several **peer dependencies**. If these dependencies are unmet, `npm install` will emit warnings. Be sure to add these dependencies to your project.
1010

1111
This package will not work without installing the `@babylonjs/react-native` peer dependency.
12-
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
12+
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.

Modules/@babylonjs/react-native-windows/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @babylonjs/react-native-windows
1+
# Babylon React Native Windows Runtime
22

33
## Usage
44

@@ -9,4 +9,4 @@ This package contains windows dependencies for @babylonjs/react-native. See @bab
99
This package has several **peer dependencies**. If these dependencies are unmet, `npm install` will emit warnings. Be sure to add these dependencies to your project.
1010

1111
This package will not work without installing the `@babylonjs/react-native` peer dependency.
12-
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.
12+
The `react-native-permissions` dependency is required for XR capabilities of Babylon.js.

Modules/@babylonjs/react-native/README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @babylonjs/react-native
1+
# Babylon React Native
22

33
## Usage
44

@@ -18,9 +18,15 @@ The minimum Android SDK version is 18. This must be set as `minSdkVersion` in th
1818

1919
The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `podfile`.
2020

21-
### Universal Windows Platform (UWP) Configuration
21+
### Platform Native Packages
2222

23-
For windows support, install `@babylonjs/react-native-windows`.
23+
Babylon React Native platform native packages must also be installed for the platforms and React Native versions being targeted. This is only needed for ***apps*** using Babylon React Native, not for ***libraries (React Native packages)*** building on top of Babylon React Native.
24+
25+
| | React Native 0.63 - 0.64 | React Native 0.65 - 0.66 |
26+
| ------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
27+
| Android | [@babylonjs/react-native-iosandroid-0-64](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-64) | [@babylonjs/react-native-iosandroid-0-65](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-65) |
28+
| iOS | [@babylonjs/react-native-iosandroid-0-64](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-64) | [@babylonjs/react-native-iosandroid-0-65](https://www.npmjs.com/package/@babylonjs/react-native-iosandroid-0-65) |
29+
| Windows | [@babylonjs/react-native-windows-0-64](https://www.npmjs.com/package/@babylonjs/react-native-windows-0-64) | [@babylonjs/react-native-windows-0-65](https://www.npmjs.com/package/@babylonjs/react-native-windows-0-65) |
2430

2531
### `useEngine`
2632

@@ -84,4 +90,4 @@ e.g.
8490
<EngineView style={{flex: 1}} camera={camera} isTransparent={true} />
8591
```
8692

87-
Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.
93+
Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.

0 commit comments

Comments
 (0)