Skip to content

Commit

Permalink
Docs updates for 2.0.0-beta.5
Browse files Browse the repository at this point in the history
  • Loading branch information
jdee committed May 19, 2017
1 parent c3037e0 commit 8eb3418
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
11 changes: 11 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,14 @@
Swift support.
* Improvements to webview_example_native_ios to take advantage of full Swift support.
* Includes native SDKs 0.14.12 (iOS), 2.6.1 (Android).

2017-05-19 Version 2.0.0-beta.5

* This release disables the unsupportable `setDebug()` method and provides new native methods to
take its place. See https://rnbranch.app.link/hGj7E61EhD for details.
* Removed the filter in the native layers that was passing null `params` to the `branch.subscribe` callback.
Now `params` will never be null in the callback. Non-Branch links are
available using the `+non_branch_link` parameter, like the rest of Branch's SDKs. See in particular the
webview_example for updated usage. The `uri` parameter still exists, and its behavior is largely unchanged, but
it should now be considered deprecated and will be removed in a future release.
* Includes native SDKs 0.14.12 (iOS), 2.8.0 (Android).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is a repository of our open source React Native SDK. Huge shoutout to our f

[Release 2.0.0]: ./docs/Release-2.0.0.md

Version 2.0.0-beta.4 is now available in NPM with a simplified SDK integration process. See [Release 2.0.0] for details.
Version 2.0.0-beta.5 is now available in NPM with a simplified SDK integration process. See [Release 2.0.0] for details.

**v1.1.0** The `createBranchUniversalObject` method is now async, so be sure to use `await` or handle the promise resolution, e.g.
```js
Expand Down
15 changes: 12 additions & 3 deletions docs/Release-2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ Further plans for 2.0.0:

## Changes

### Building, configuration and examples

- The native iOS SDK source (version 0.14.12) is now included in the RNBranch project and is no longer a required external dependency.
- A jar file (version 2.6.1) is included for the Android SDK.
- A jar file (version 2.8.0) is included for the Android SDK.
- A Branch-SDK podspec is included in the NPM module for use in native apps that use the React pod from node_modules.
- Five new testbed apps are available:
+ testbed_simple illustrates the simplest way to integrate the SDK using `react-native link`.
Expand All @@ -34,7 +36,14 @@ Further plans for 2.0.0:

### JS API changes

Added missing `AddToCartEvent`, which was listed in the docs but not present in the SDK.
- Added missing `AddToCartEvent`, which was listed in the docs but not present in the SDK.
- Disabled `setDebug()`, which has never worked and is unsupportable. See https://rnbranch.app.link/hGj7E61EhD
for details.
- Removed the filter in the native layers that was passing null `params` to the `branch.subscribe` callback.
Now `params` will never be null in the callback. Non-Branch links are
available using the `+non_branch_link` parameter, like the rest of Branch's SDKs. See in particular the
webview_example for updated usage. The `uri` parameter still exists, and its behavior is largely unchanged, but
it should now be considered deprecated and will be removed in a future release.

### iOS API changes

Expand All @@ -52,7 +61,7 @@ An overload of `Branch.initSession` was introduced that accepts a `Branch.Branch
#### Simple

```bash
npm install --save [email protected].4
npm install --save [email protected].5
react-native link react-native-branch
```

Expand Down

0 comments on commit 8eb3418

Please sign in to comment.