Skip to content

Commit f1e704d

Browse files
authored
Merge pull request #38 from rudderlabs/docs/sdk-3197-update-readme
docs: update readme to include minSdk requirement note for v2.0.0
2 parents 2d2d212 + 9e44ff7 commit f1e704d

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@ More information on RudderStack can be found [here](https://github.com/rudderlab
99
1. Add [Braze](https://www.braze.com) as a destination in the [Dashboard](https://app.rudderstack.com/) and define ```apiToken```
1010

1111
2. Add the dependency under ```dependencies```
12-
```
12+
```groovy
1313
implementation 'com.rudderstack.android.sdk:core:[1.0,2.0)'
14-
implementation 'com.rudderstack.android.integration:braze:1.0.8'
14+
implementation 'com.rudderstack.android.integration:braze:2.0.0'
1515
```
1616

17+
> **Note:** Braze integration version `2.0.0` and above requires a minimum SDK version (`minSdkVersion`) of **25** or above.
18+
1719
3. Add required permissions to ```AndroidManifest.xml```
18-
```
20+
```xml
1921
<uses-permission android:name="android.permission.INTERNET" />
2022
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
2123
```
2224

2325
## Initialize ```RudderClient```
2426

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

4345
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.
46+

0 commit comments

Comments
 (0)