Skip to content

Commit b7e0e76

Browse files
committed
docs: update documentation to cover app configuration issues
1 parent 847f855 commit b7e0e76

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,26 @@ import { NavigationView } from '@googlemaps/react-native-navigation-sdk';
4141

4242
### Android
4343

44-
1. Set the `minSdkVersion` in `android/app/build.gradle`:
44+
#### Disable new architecture
45+
46+
This package does not yet support new architecture. Make sure new architecture is disabled in your `android/gradle.properties` file:
47+
48+
```groovy
49+
newArchEnabled=false
50+
```
51+
52+
#### Enable Jetifier
53+
54+
To ensure compatibility with AndroidX, enable Jetifier in your `android/gradle.properties` file:
55+
56+
```groovy
57+
# Automatically convert third-party libraries to use AndroidX
58+
android.enableJetifier=true
59+
```
60+
61+
#### Minimum SDK Requirements for Android
62+
63+
The `minSdkVersion` for your Android project must be set to 23 or higher in `android/app/build.gradle`:
4564

4665
```groovy
4766
android {
@@ -51,12 +70,42 @@ android {
5170
}
5271
```
5372

73+
If `minSdkVersion` is set to less than 34 (API 34), you need to configure desugaring for your Android app.
74+
To enable desugaring, add the following configurations to `android/app/build.gradle` file:
75+
```groovy
76+
android {
77+
...
78+
compileOptions {
79+
coreLibraryDesugaringEnabled true
80+
...
81+
}
82+
}
83+
84+
dependencies {
85+
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.4'
86+
}
87+
```
88+
89+
You may also need to upgrade to Gradle 8.4 and the Android Gradle plugin version 8.3.0
90+
91+
#### Set Google Maps API Key
92+
5493
To securely store your API key, it is recommended to use the [Google Maps Secrets Gradle Plugin](https://developers.google.com/maps/documentation/android-sdk/secrets-gradle-plugin). This plugin helps manage API keys without exposing them in your app's source code.
5594

5695
See example configuration for secrets plugin at example applications [build.gradle](./example/android/app/build.gradle) file.
5796

5897
### iOS
5998

99+
#### Disable new architecture
100+
101+
This package does not yet support new architecture. Make sure new architecture is disabled in your `ios/Podfile`:
102+
103+
```ruby
104+
ENV['RCT_NEW_ARCH_ENABLED'] = '0'
105+
```
106+
107+
#### Set Google Maps API Key
108+
60109
To set up, specify your API key in the application delegate `ios/Runner/AppDelegate.m`:
61110

62111
```objective-c

0 commit comments

Comments
 (0)