Skip to content

Revise README for plugin setup instructions #53

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
skydoves merged 1 commit into from
Nov 16, 2025
Merged

Revise README for plugin setup instructions #53

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: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,17 +136,24 @@ This is incredibly useful for:

[![Maven Central](https://img.shields.io/maven-central/v/com.github.skydoves/compose-stability-runtime.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.skydoves%22%20AND%20a:%compose-stability-runtime%22)

Add the dependency below to your `libs.versions.toml` file:
First, add the plugin to the `[plugins]` section of your `libs.versions.toml` file:

```toml
stability-analyzer = { id = "com.github.skydoves.compose.stability.analyzer", version = "0.5.2" }
```

Next, apply the plugin on your root's `build.gradle.kts` file like below:
Then, apply it to your root `build.gradle.kts` with `apply false`:

```kotlin
alias(libs.plugins.stability.analyzer) apply false
```

Finally, apply the plugin to your app or shared module's `build.gradle.kts`:

```kotlin
alias(libs.plugins.stability.analyzer)
```
Sync your project to complete the setup.

### Kotlin Version Mapping

Expand Down