Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
emirhanemmez committed Nov 28, 2023
1 parent dbf638a commit 310a981
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,43 @@ A customizable progressbar component can be used in onboarding screens for Jetpa

![MultiStepsProgressBar Preview](https://github.com/emirhanemmez/MultiStepsProgressBar/blob/main/screenshot/multistepsprogressbarpreview.png)

## Implementation

Add jitpack.io maven to **settings.gradle.kts**

```
pluginManagement {
repositories {
google {
content {
includeGroupByRegex("com\\.android.*")
includeGroupByRegex("com\\.google.*")
includeGroupByRegex("androidx.*")
}
}
mavenCentral()
mavenLocal()
maven(url = "https://jitpack.io")
gradlePluginPortal()
}
}
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenLocal()
maven(url = "https://jitpack.io")
mavenCentral()
}
}
```

Add library dependency to your **build.gradle.kts**

```
implementation("com.github.emirhanemmez:MultiStepsProgressBar:version")
```

## Usage

Define your **stepList** as **SnapShotStateList** in your ViewModel. For example:
Expand Down
2 changes: 1 addition & 1 deletion app/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ android {
}

dependencies {
implementation("com.github.emirhanemmez:MultiStepsProgressBar:1.0")
implementation(project(":multistepsprogressbar"))
implementation(libs.androidx.core.ktx)
implementation(libs.androidx.lifecycle.runtime.ktx)
implementation(libs.androidx.activity.compose)
Expand Down
1 change: 0 additions & 1 deletion multistepsprogressbar/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,3 @@ afterEvaluate {
}
}
}

0 comments on commit 310a981

Please sign in to comment.