klaviyo
diff --git a/Diff for: ‎.github/actions/setup/action.yml
+1-1 b/Diff for: ‎.github/actions/setup/action.yml
+1-1
diff --git a/Diff for: ‎.github/workflows/android-ci.yml
+3-3 b/Diff for: ‎.github/workflows/android-ci.yml
+3-3
diff --git a/Diff for: ‎README.md
+60-1 b/Diff for: ‎README.md
+60-1
diff --git a/Diff for: ‎android/build.gradle
+3-2 b/Diff for: ‎android/build.gradle
+3-2
diff --git a/Diff for: ‎android/gradle.properties
+1 b/Diff for: ‎android/gradle.properties
+1
diff --git a/Diff for: ‎android/src/main/java/com/klaviyoreactnativesdk/KlaviyoReactNativeSdkModule.kt
+16 b/Diff for: ‎android/src/main/java/com/klaviyoreactnativesdk/KlaviyoReactNativeSdkModule.kt
+16
diff --git a/Diff for: ‎android/src/oldarch/KlaviyoReactNativeSdkSpec.kt
+6 b/Diff for: ‎android/src/oldarch/KlaviyoReactNativeSdkSpec.kt
+6
diff --git a/Diff for: ‎docs/assets/search.js
+1-1 b/Diff for: ‎docs/assets/search.js
+1-1
@@ -22,6 +22,6 @@ runs:
           ${{ runner.os }}-yarn-
 
     - name: Install dependencies
-      if: steps.yarn-cache.outputs.cache-hit != 'true'
+      if: steps.yarn-cache.outputs.cache-hit != 'true' || ${{ github.run_attempt > 1 }}
       run: yarn install --immutable
       shell: bash
@@ -40,19 +40,19 @@ jobs:
           fi
 
       - name: Install JDK
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: '17'
 
       - name: Finalize Android SDK
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         run: |
           /bin/bash -c "yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses > /dev/null"
 
       - name: Cache Gradle
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         uses: actions/cache@v4
         with:
           path: |
 
@@ -68,7 +68,11 @@ We are actively testing and expanding support to the latest patch releases of re
 
 - Minimum Deployment Target `13.0+`
 
-## Installation
+The Klaviyo React Native SDK allows developers to incorporate Klaviyo analytics and push notification functionality in
+their React Native applications for Android and iOS. It is a Typescript wrapper (native module bridge) around the native
+Klaviyo iOS and Android SDKs. For more information on the native SDKs, please see the
+[iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk).
+repositories. This repo also contains a basic [React Native sample app](./example) to assist your integration.
 
 The Klaviyo React Native SDK is available via [NPM](http://npmjs.com). To add it to your project,
 run the following from your project's root directory:
@@ -121,6 +125,61 @@ We are actively working to verify compatibility with these versions. If you enco
 After installing the npm package, run the following command in the `ios` directory of your React Native project.
 Install [Cocoapods](https://cocoapods.org/) if you have not already.
 
+### React Native
+
+## Initialization
+
+The SDK must be initialized with the short alphanumeric
+[public API key](https://help.klaviyo.com/hc/en-us/articles/115005062267#difference-between-public-and-private-api-keys1)
+for your Klaviyo account, also known as your Site ID. Initialization is done in the native layer, and must occur before
+any other SDK methods can be invoked. Follow the native SDK instructions for initialization, and refer to the
+[example app](./example) in this repository for guidance:
+
+- [Android SDK instructions](https://github.com/klaviyo/klaviyo-android-sdk#Initialization), and
+  [example app `MainApplication.kt`](./example/android/app/src/main/java/com/klaviyoreactnativesdkexample/MainApplication.kt#L39)
+- [iOS SDK instructions](https://github.com/klaviyo/klaviyo-swift-sdk#Initialization), and
+  [example app `AppDelegate.mm`](./example/ios/KlaviyoReactNativeSdkExample/AppDelegate.mm#L14)
+
+### Example App
+We have included a bare-bones example app in this repository for reference of how to integrate with our SDK.
+It is primarily intended to give code samples such as how and where to `initialize` or how to implement notification
+delegate methods on iOS. To actually run the example app:
+- Clone this repository
+- From the root directory, run `yarn example-setup`. This is an alias that will do the following:
+  - Run `yarn install --immutable` from the root directory
+  - Navigate to the `example` directory and run `bundle install`
+  - Navigate to the `example/ios` directory and run `bundle exec pod install`
+- From the project's root directory, run `yarn example start` to start the example application. Follow the
+  metro instructions from here, i.e. press `i` to run on iOS or `a` to run on Android.
+
+### Android
+
+Android installation requirements may vary depending upon your project configuration and other dependencies.
+The Klaviyo React Native SDK's `build.gradle` file exposes transitive dependencies upon the Klaviyo Android SDK,
+so you can import Android Klaviyo SDK references from your Kotlin/Java files without modifying your gradle configuration.
+
+#### React Native 0.73.x
+
+There are no additional installation requirements. Android support is fully tested and verified,
+including `minSdkVersion=23`.
+
+#### React Native 0.68.x - 0.72.x
+
+We have successfully compiled the Klaviyo React Native SDK in a bare React Native template app for these versions
+with the following modifications to the `android/build.gradle` file:
+
+- Set `compileSdkVersion=34`
+- Set `minSdkVersion=23`
+
+#### React Native <= 0.67.x
+
+We are actively working to verify compatibility with these versions. If you encounter issues, please file an issue.
+
+### iOS
+
+After installing the npm package, run the following command in the `ios` directory of your React Native project.
+Install [Cocoapods](https://cocoapods.org/) if you have not already.
+
 #### React Native 0.68.x - 0.72.x
 We have successfully compiled the Klaviyo React Native SDK in a bare React Native template app for these versions
 with the following modifications to the `android/build.gradle` file:
 
@@ -102,6 +102,7 @@ repositories {
   google()
 }
 
+def klaviyoAndroidSdkVersion = getExtOrDefault("klaviyoAndroidSdkVersion")
 def kotlin_version = getExtOrDefault("kotlinVersion")
 def localProperties = new Properties()
 if (rootProject.file("local.properties").canRead()) {
@@ -126,8 +127,8 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // Klaviyo Android SDK
-  api "com.github.klaviyo.klaviyo-android-sdk:analytics:2.0.0"
-  api "com.github.klaviyo.klaviyo-android-sdk:push-fcm:2.0.0"
+  api "com.github.klaviyo.klaviyo-android-sdk:analytics:$klaviyoAndroidSdkVersion"
+  api "com.github.klaviyo.klaviyo-android-sdk:push-fcm:$klaviyoAndroidSdkVersion"
 
   // We used reflection to enumerate keywords in the Klaviyo Android SDK dynamically
   implementation "org.jetbrains.kotlin:kotlin-reflect:1.8.21"
 
@@ -11,6 +11,7 @@ org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryErro
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
 #Tue Dec 19 15:08:27 EST 2023
+KlaviyoReactNativeSdk_klaviyoAndroidSdkVersion=2.1.0
 KlaviyoReactNativeSdk_compileSdkVersion=31
 KlaviyoReactNativeSdk_kotlinVersion=1.8.0
 KlaviyoReactNativeSdk_minSdkVersion=23
 
@@ -45,6 +45,11 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
       }
     }
 
+    @ReactMethod
+    override fun initialize(apiKey: String) {
+      Klaviyo.initialize(apiKey, context)
+    }
+
     @ReactMethod
     override fun setProfile(profile: ReadableMap) {
       val parsedProfile = Profile()
@@ -57,6 +62,7 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
                 parsedProfile[key] = value
               }
             }
+
           else ->
             if (value is Serializable) {
               parsedProfile[key] = value
@@ -110,6 +116,16 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
       Klaviyo.resetProfile()
     }
 
+    @ReactMethod
+    override fun setPushToken(token: String) {
+      Klaviyo.setPushToken(token)
+    }
+
+    @ReactMethod
+    override fun getPushToken(callback: Callback) {
+      callback.invoke(Klaviyo.getPushToken())
+    }
+
     @ReactMethod
     override fun createEvent(event: ReadableMap) {
       val klaviyoEvent =
 
@@ -7,6 +7,8 @@ import com.facebook.react.bridge.ReadableMap
 
 abstract class KlaviyoReactNativeSdkSpec internal constructor(context: ReactApplicationContext) :
   ReactContextBaseJavaModule(context) {
+    abstract fun initialize(apiKey: String)
+
     abstract fun setProfile(profile: ReadableMap)
 
     abstract fun setExternalId(externalId: String)
@@ -28,5 +30,9 @@ abstract class KlaviyoReactNativeSdkSpec internal constructor(context: ReactAppl
 
     abstract fun resetProfile()
 
+    abstract fun setPushToken(token: String)
+
+    abstract fun getPushToken(callback: Callback)
+
     abstract fun createEvent(event: ReadableMap)
   }