react-native-appboy-sdk - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

CHANGELOG.md

@@ -0,16 +1,37 @@
+## 1.1.0
+
+##### Breaking
+- **Update Required** — Fixes a bug in the [iOS bridge](https://github.com/Appboy/appboy-react-sdk/blob/master/iOS/AppboyReactBridge/AppboyReactBridge/AppboyReactBridge.m) where custom attribute dates were converted incorrectly, causing incorrect date data to be sent to Appboy. As a result of the fix, `setDateCustomUserAttribute()` in the iOS Appboy React bridge may now only be called with a double. 
+  - Note: The default Javascript Appboy interface has not changed, so for most integrations this just requires updating the SDK, unless you were manually calling our iOS bridge outside of our recommended integration.
+  - See https://github.com/Appboy/appboy-react-sdk/issues/7
+
 ## 1.0.0
-- Targets [Appboy Android SDK version 1.15.3](https://github.com/Appboy/appboy-android-sdk/blob/master/CHANGELOG.md#1153) and [Appboy iOS SDK version 2.24.2](https://github.com/Appboy/appboy-ios-sdk/blob/master/CHANGELOG.md#2242).
+
+##### Breaking
 - **Update Required** — Updates iOS push handling in the AppboyProject sample project to be compatible with iOS 10. For more information, refer to the CHANGELOG for [Appboy iOS SDK v2.24.0](https://github.com/Appboy/appboy-ios-sdk/blob/master/CHANGELOG.md#2240).
+
+##### Added
 - Adds callbacks to the native bindings to provide function call results to React Native.
 - Exposes `ReactAppboy.getCardCountForCategories()` and `ReactAppboy.getUnreadCardCountForCategories()` for retrieving News Feed card counts.
+  - See https://github.com/Appboy/appboy-react-sdk/issues/1
 - Adds `ReactAppboy.getInitialURL()` for handling deep links when an iOS application is launched from the suspended state by clicking on a push notification with a deep link. See `componentDidMount()` in `AppboyProject.js` for a sample implementation.
 - Exposes `ReactAppboy.setTwitterData()` and `ReactAppboy.setFacebookData()` for Twitter and Facebook integration.
-- Removes `AppboyBroadcastReceiver.java` from the AppboyProject sample project, as Appboy Android SDK v1.15.0 removes the need for a custom `AppboyBroadcastReceiver` for Appboy push notifications.
+  - See https://github.com/Appboy/appboy-react-sdk/issues/4
+
+##### Changed
+- Targets [Appboy Android SDK version 1.15.3](https://github.com/Appboy/appboy-android-sdk/blob/master/CHANGELOG.md#1153) and [Appboy iOS SDK version 2.24.2](https://github.com/Appboy/appboy-ios-sdk/blob/master/CHANGELOG.md#2242).
+- Updates the AppboyProject sample application to React Native v0.33.0.
 - Updates the AppboyProject sample project to integrate session handling and in-app message manager registration using an [AppboyLifecycleCallbackListener](https://github.com/Appboy/appboy-android-sdk/blob/master/android-sdk-ui/src/com/appboy/AppboyLifecycleCallbackListener.java), as introduced in Appboy Android SDK v1.15.0.
-- Updates the AppboyProject sample application to React Native v0.33.0.
 
+##### Removed
+- Removes `AppboyBroadcastReceiver.java` from the AppboyProject sample project, as Appboy Android SDK v1.15.0 removes the need for a custom `AppboyBroadcastReceiver` for Appboy push notifications.
+
 ## 0.3.0
+
+##### Changed
 - Renames Android module to conform to rnpm standard.
 
 ## 0.2.0
+
+##### Changed
 - Refactors Android module to have the source directly under the `android` folder.
@@ -17,0 +38,0 @@

package.json

 {
   "name": "react-native-appboy-sdk",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Appboy SDK for React Native.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -7,86 +7,2 @@ ![Appboy Logo](https://github.com/Appboy/appboy-react-sdk/blob/master/Appboy_Logo_400x100.png)
 
-## Getting Started (Default setup)
-
-### iOS
-1.  Install the Appboy iOS SDK into your iOS project.  See instructions for Cocoapods and manual integration at https://documentation.appboy.com/iOS/.  See notes below for further information.
-2. `npm install react-native-appboy-sdk@latest --save`
-3. `rnpm link`
-
-##### Notes:
-- If you do a Cocoapods integration for the first time, you need to add `$(inherited)` to the `Other linker flags` configuration in your app.
-- If you do a manual integration, our library expects the AppboyKit folder to be under the root of the ios project directory.
-- We've also inserted the token `APPBOY_LIBRARY_SEARCH_PATH` in the header search path, so that folks who find the default paths insufficient and care replace that token can do so.  If there are any standard search paths that you think would be universally applicable, please leave an issue on the repo or a pull request and we'll update it.
-
-#### iOS without rnpm
-rpnm will automatically link the node package to your project.  If you decide not to use it, follow these steps.
-
-1. `npm install react-native-appboy-sdk@latest --save`
-2. In the XCode's "Project navigator", right click on your project's Libraries folder ➜ `Add Files to <...>`
-3. Go to `node_modules` ➜ `react-native-appboy-sdk` ➜ `ios` ➜ select `AppboyReactBridge.xcodeproj`
-4. Add `AppboyReactBridge.a` to `Build Phases -> Link Binary With Libraries`
-5. Update the 'Header Search Paths' in the AppboyReactBridge Xcode project to reference the headers directory of your installation of the Appboy iOS SDK.
-
-#### iOS completing the integration
-1.  Follow the directions at https://documentation.appboy.com/ to finish your integration. 
-2.  When you need to make Appboy calls from javascript, use the following declaration to import the javascript module:
-
-```
-const ReactAppboy = require('react-native-appboy-sdk');
-``` 
-
-### Android
-1. `npm install react-native-appboy-sdk@latest --save`
-2. `rnpm link`
-3. Add the Appboy repository to your project:
-```gradle
-// file: android/build.gradle
-...
-
-allprojects {
-  repositories {
-    ...
-    maven { url "http://appboy.github.io/appboy-android-sdk/sdk" }
-  }
-}
-```
-
-#### Android without rnpm
-1. `npm install react-native-appboy-sdk@latest --save`
-2. Link the project by adding the following:
-
-```gradle
-// file: android/settings.gradle
-...
-
-include ':react-native-android-sdk'
-project(':react-native-android-sdk').projectDir = new File(settingsDir, '../node_modules/react-native-appboy-sdk/android')
-```
-```gradle
-// file: android/build.gradle
-...
-
-allprojects {
-  repositories {
-    ...
-    maven { url "http://appboy.github.io/appboy-android-sdk/sdk" }
-  }
-}
-```
-```gradle
-// file: android/app/build.gradle
-...
-
-dependencies {
-    ...
-    compile project(':react-native-appboy-sdk')
-}
-```
-
-#### Android completing the integration
-1.  Follow the directions at https://documentation.appboy.com/ to finish your integration. 
-2.  When you need to make Appboy calls from javascript, use the following declaration to import the javascript module:
-
-```
-const ReactAppboy = require('react-native-appboy-sdk');
-```
-
+See our [Technical Documentation](http://documentation.appboy.com "Appboy Technical Documentation") for instructions on integrating Appboy into your React Native App.

No alert changes

Worsened metrics

Total package byte prevSize

104781

decreased by-1.61%

Number of lines in readme file

8

decreased by-91.3%

No dependency changes