Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Featured

[![CI](https://github.com/AndroidBroadcast/Featured/actions/workflows/ci.yml/badge.svg)](https://github.com/AndroidBroadcast/Featured/actions/workflows/ci.yml)
[![Maven Central](https://img.shields.io/maven-central/v/dev.androidbroadcast.featured/core.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=dev.androidbroadcast.featured)
[![Maven Central](https://img.shields.io/maven-central/v/dev.androidbroadcast.featured/featured-core.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=dev.androidbroadcast.featured)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

**Featured** is a type-safe, reactive feature-flag and configuration management library for Kotlin Multiplatform (Android, iOS, JVM). Declare flags in shared Kotlin code, read them at runtime from local or remote providers, and let the Gradle plugin dead-code-eliminate disabled flags from your production binaries.
Expand Down Expand Up @@ -67,19 +67,19 @@ dependencies {
implementation(platform("dev.androidbroadcast.featured:featured-bom:<version>"))

// Core runtime — always required
implementation("dev.androidbroadcast.featured:core")
implementation("dev.androidbroadcast.featured:featured-core")

// Optional modules — add only what you use
implementation("dev.androidbroadcast.featured:featured-compose") // Compose extensions
debugImplementation("dev.androidbroadcast.featured:featured-registry") // Flag registry for debug UI
debugImplementation("dev.androidbroadcast.featured:featured-debug-ui") // Debug screen

// Local persistence providers — pick one (or both)
implementation("dev.androidbroadcast.featured:datastore-provider")
implementation("dev.androidbroadcast.featured:sharedpreferences-provider")
implementation("dev.androidbroadcast.featured:featured-datastore-provider")
implementation("dev.androidbroadcast.featured:featured-sharedpreferences-provider")

// Remote provider
implementation("dev.androidbroadcast.featured:firebase-provider")
implementation("dev.androidbroadcast.featured:featured-firebase-provider")
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ dependencies {
implementation(platform("dev.androidbroadcast.featured:featured-bom:<version>"))

// Core runtime — always required
implementation("dev.androidbroadcast.featured:core")
implementation("dev.androidbroadcast.featured:featured-core")

// Optional modules — add only what you use
implementation("dev.androidbroadcast.featured:featured-compose") // Compose extensions
debugImplementation("dev.androidbroadcast.featured:featured-registry") // Flag registry for debug UI
debugImplementation("dev.androidbroadcast.featured:featured-debug-ui") // Debug screen

// Local persistence providers — pick one (or both)
implementation("dev.androidbroadcast.featured:datastore-provider")
implementation("dev.androidbroadcast.featured:sharedpreferences-provider")
implementation("dev.androidbroadcast.featured:featured-datastore-provider")
implementation("dev.androidbroadcast.featured:featured-sharedpreferences-provider")

// Remote provider
implementation("dev.androidbroadcast.featured:firebase-provider")
implementation("dev.androidbroadcast.featured:featured-firebase-provider")
}
```

Expand Down
Loading