diff --git a/README.md b/README.md index b502752..51c0d29 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ -Blainks Android SDK +# Blainks Android SDK + +Push notification and messaging SDK for Android applications. + +## Installation + +### Gradle (Kotlin DSL) + +Add the repository to your `settings.gradle.kts`: + +```kotlin +dependencyResolutionManagement { + repositories { + google() + mavenCentral() + maven { url = uri("https://blainks.com/maven") } + } +} +``` + +Add the dependency to your app's `build.gradle.kts`: + +```kotlin +dependencies { + implementation("com.blainks:blaink:1.3.71") +} +``` + +## Requirements + +- Android API 21+ (Android 5.0 Lollipop) +- Kotlin 1.9+ +- Android Gradle Plugin 8.0+ + +## Documentation + +For detailed documentation, visit [blainks.com/developer](https://blainks.com/developer). \ No newline at end of file