Skip to content

Commit c487cee

Browse files
committed
Update to notes on 2.0.0
1 parent ba97585 commit c487cee

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

docs/Release-2.0.0.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,34 @@ production. Please open issues in this repo with any questions or problems.
1616
Further plans for 2.0.0:
1717

1818
- Provide a script to automate project configuration changes, such as adding a Branch key and setting up Universal Link/App Link domains.
19-
- Provide a testbed_native_android illustrating integration into an existing Android app.
19+
- Review/flesh out the native API for link routing on both platforms.
20+
- Consistent error codes across the two platforms.
2021
- TBD
2122

2223
## Changes
2324

24-
- The native iOS SDK source (version 0.13.5) is now included in the RNBranch project and is no longer a required external dependency.
25-
- A jar file (version 2.5.9) is included for the Android SDK.
25+
- The native iOS SDK source (version 0.14.12) is now included in the RNBranch project and is no longer a required external dependency.
26+
- A jar file (version 2.6.1) is included for the Android SDK.
2627
- A Branch-SDK podspec is included in the NPM module for use in native apps that use the React pod from node_modules.
27-
- Two new testbed apps are available:
28+
- Five new testbed apps are available:
2829
+ testbed_simple illustrates the simplest way to integrate the SDK using `react-native link`.
2930
+ testbed_native_ios illustrates including `react-native-branch` in a React Native component within a native iOS app.
31+
+ testbed_native_android illustrates including `react-native-branch` in a React Native component within a native Android app.
32+
+ webview_example is a realistic example of SDK integration following best practices.
33+
+ webview_example_native_ios is a realistic example of SDK integration in a React Native component within a Swift app.
3034

31-
There have so far been no API changes in 2.0.0.
35+
### JS API changes
36+
37+
Added missing `AddToCartEvent`, which was listed in the docs but not present in the SDK.
38+
39+
### iOS API changes
40+
41+
An `RNBranchLinkOpenedNotification` was added to allow link routing in native apps that integrate `react-native-branch`.
42+
See testbed_native_ios and webview_example_native_ios for examples.
43+
44+
### Android API changes
45+
46+
An overload of `Branch.initSession` was introduced that accepts a `Branch.BranchUniversalReferralInitListener` to allow link routing in native apps that integrate `react-native-branch`. An `RNBranchModule.NATIVE_INIT_SESSION_FINISHED_EVENT` local broadcast is also available for the same purpose. See testbed_native_android for an example.
3247

3348
## SDK Integration
3449

@@ -37,7 +52,7 @@ There have so far been no API changes in 2.0.0.
3752
#### Simple
3853

3954
```bash
40-
npm install --save react-native-branch@2.0.0-beta.1
55+
npm install --save react-native-branch@2.0.0-beta.4
4156
react-native link react-native-branch
4257
```
4358

@@ -50,6 +65,8 @@ There's no need for CocoaPods or Carthage. The testbed_simple app was built this
5065
Add both the `react-native-branch` and `Branch-SDK` pods to your Podfile like this:
5166
```Ruby
5267
pod "React", path: "../node_modules/react-native"
68+
# The following line is necessary with use_frameworks! or RN >= 0.42.
69+
pod "Yoga", path: "../node_modules/react-native/ReactCommon/yoga"
5370
pod "react-native-branch", path: "../node_modules/react-native-branch"
5471
pod "Branch-SDK", path: "../node_modules/react-native-branch/ios"
5572
```
@@ -77,6 +94,8 @@ If you added CocoaPods to your project just for the Branch pod, you can remove C
7794
Replace `pod "Branch"` in your Podfile with `pod "Branch-SDK", path: "../node_modules/react-native-branch/ios"`.
7895
```Ruby
7996
pod "React", path: "../node_modules/react-native"
97+
# The following line is necessary with use_frameworks! or RN >= 0.42.
98+
pod "Yoga", path: "../node_modules/react-native/ReactCommon/yoga"
8099
pod "react-native-branch", path: "../node_modules/react-native-branch"
81100
pod "Branch-SDK", path: "../node_modules/react-native-branch/ios"
82101
```

0 commit comments

Comments
 (0)