diff --git a/README.md b/README.md index f976b3be..deeab4ea 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,25 @@ message and web push notification campaigns to your customers. This SDK helps you integrate your React Native-based iOS and Android apps with Iterable. It supports JavaScript and TypeScript. + + + + + +- [Requirements](#requirements) +- [Architecture Support](#architecture-support) +- [Installation](#installation) +- [Features](#features) +- [Sample projects](#sample-projects) +- [Version mapping](#version-mapping) +- [Release notes, support and troubleshooting](#release-notes-support-and-troubleshooting) +- [License](#license) +- [Want to contribute?](#want-to-contribute) + + + + + ## Requirements Iterable's React Native SDK relies on: @@ -33,6 +52,10 @@ Iterable's React Native SDK relies on: - [`minSdkVersion` 21+, `compileSdkVersion` 31+](https://medium.com/androiddevelopers/picking-your-compilesdkversion-minsdkversion-targetsdkversion-a098a0341ebd) - [Iterable's Android SDK](https://github.com/Iterable/iterable-android-sdk) +## Architecture Support + +**Important**: Iterable's React Native SDK currently does not support [React Native's New Architecture](https://reactnative.dev/architecture/landing-page) (Fabric, TurboModules, and Codegen). The SDK is designed to work with the **legacy architecture only**. If you're using the New Architecture in your React Native application, you may encounter compatibility issues. + ## Installation For installation instructions, read [Installing Iterable's React Native SDK](https://support.iterable.com/hc/articles/360045714132).