Getting started¶
Install¶
Add Maven Central to your Gradle setup, then add the module(s) you want.
// build.gradle.kts (per consumer module)
repositories {
mavenCentral()
}
dependencies {
implementation("io.github.mobilebytelabs:cmp-share:3.5.1")
implementation("io.github.mobilebytelabs:cmp-share-compose:3.5.1")
// ...other cmp-* modules as needed
}
Pin all modules to the same version
All modules share a single kmptoolkit.version. Mixing versions
across cmp-* artifacts works for compatible minor releases but is
not guaranteed across majors — pin them all together to keep
transitive interop predictable.
Koin wiring (optional — for modules that ship a Koin companion)¶
import com.mobilebytelabs.kmptoolkit.observe.koin.observeKoinModule
import com.mobilebytelabs.kmptoolkit.observe.koin.FirebaseCrashlyticsAttributionHook
import com.mobilebytelabs.kmptoolkit.observe.koin.FirebaseAnalyticsHealthHook
startKoin {
modules(
observeKoinModule(
hooks = listOf(
FirebaseCrashlyticsAttributionHook(),
FirebaseAnalyticsHealthHook(),
),
),
)
}
First-screen example¶
See Cookbook → Share text from a button for a minimal share button you can copy into a Compose screen.
What's next¶
- Browse Modules for per-module READMEs + DEVELOPMENT.md excerpts.
- Browse the Cookbook for task-oriented recipes.
API reference
Open the -javadoc.jar for any module in IntelliJ / Android Studio —
full KDoc surfaces automatically when the dependency is added. No
separate API site to bookmark.