Skip to content

docs: update readme to include minSdk requirement note for v2.0.0 #38

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
vgupta98 merged 1 commit into from
Apr 25, 2025
Merged

docs: update readme to include minSdk requirement note for v2.0.0 #38

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
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,22 @@ More information on RudderStack can be found [here](https://github.com/rudderlab
1. Add [Braze](https://www.braze.com) as a destination in the [Dashboard](https://app.rudderstack.com/) and define ```apiToken```

2. Add the dependency under ```dependencies```
```
```groovy
implementation 'com.rudderstack.android.sdk:core:[1.0,2.0)'
implementation 'com.rudderstack.android.integration:braze:1.0.8'
implementation 'com.rudderstack.android.integration:braze:2.0.0'
```

> **Note:** Braze integration version `2.0.0` and above requires a minimum SDK version (`minSdkVersion`) of **25** or above.

3. Add required permissions to ```AndroidManifest.xml```
```
```xml
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
```

## Initialize ```RudderClient```

```
```kotlin
val rudderClient: RudderClient = RudderClient.getInstance(
this,
<WRITE_KEY>,
Expand All @@ -41,3 +43,4 @@ Follow the steps from the [RudderStack Android SDK](https://github.com/rudderlab
## Contact Us

If you come across any issues while configuring or using this integration, please feel free to start a conversation on our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you.

Loading