Skip to content

docs: Update setup guide for ios and platform compatibility in README.md #1170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
subhankarmaiti merged 1 commit into from
May 13, 2025
Merged

docs: Update setup guide for ios and platform compatibility in README.md #1170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,25 @@ We're excited to announce the release of react-native-auth0 `v4.0.0`! Please not

### Requirements

This SDK targets apps that are using React Native SDK version `0.76.0` and up. If you're using an older React Native version, see the compatibility matrix below.
This SDK targets apps that are using React Native SDK version `0.78.0` and up. If you're using an older React Native version, see the compatibility matrix below.

This SDK fully supports React Native New Architecture and Expo 53+.

> ⚠️ **Warning**: If you are using Expo version less than 53, you need to use react-native-auth0 version 4.x or earlier. Version 5.x supports Expo 53 and above.

### Platform compatibility

The following shows platform minimums for running projects with this SDK:

| Platform | Minimum version |
| -------- | :-------------: |
| iOS | 13.0 |
| Android | 34 |
| iOS | 14.0 |
| Android | 35 |

Our SDK requires a minimum iOS deployment target of 13.0. In your project's ios/Podfile, ensure your platform target is set to 13.0.
Our SDK requires a minimum iOS deployment target of 14.0. In your project's ios/Podfile, ensure your platform target is set to 14.0.

```
platform :ios, '13.0'
platform :ios, '14.0'
```

### Installation
Expand Down Expand Up @@ -123,6 +127,8 @@ Re-declare the activity manually with `tools:node="remove"` in your app's Androi

Inside the `ios` folder find the file `AppDelegate.[swift|m]` add the following to it:

For Objective-C:

```objc
#import <React/RCTLinkingManager.h>

Expand All @@ -133,6 +139,14 @@ Inside the `ios` folder find the file `AppDelegate.[swift|m]` add the following
}
```

For Swift:

```swift
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
return RCTLinkingManager.application(app, open: url, options: options)
}
```

Inside the `ios` folder open the `Info.plist` and locate the value for `CFBundleIdentifier`, e.g.

```xml
Expand Down