Skip to content

Commit 44aab96

Browse files
committed
Update README.md
1 parent b06b72e commit 44aab96

File tree

6 files changed

+37
-21
lines changed

6 files changed

+37
-21
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,38 @@ fun ListDetailScreen() {
5757
}
5858
```
5959

60-
### Installation and Usage
60+
### Installation
6161

62-
Documentation [here](https://xxfast.github.io/Decompose-Router/)
62+
Decompose-Router is published on Maven Central. Latest version [![Maven Central](https://img.shields.io/maven-central/v/io.github.xxfast/decompose-router?color=blue)](https://search.maven.org/search?q=g:io.github.xxfast)
63+
```kotlin
64+
repositories {
65+
mavenCentral()
66+
// or for snapshot builds
67+
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
68+
}
69+
```
70+
71+
> **Note** - Check for compatible versions of Decompose and Compose in the [version catalog] [version catalog](gradle/libs.versions.toml)
72+
73+
```toml
74+
[versions]
75+
decompose-router = "0.8.0"
76+
77+
[libraries]
78+
# For Jetpack Compose / Compose Multiplatform
79+
decompose-router = { module = "io.github.xxfast:decompose-router", version.ref = "decompose-router" }
80+
81+
# For Compose Wear
82+
decompose-router-wear = { module = "io.github.xxfast:decompose-router-wear", version.ref = "decompose-router" }
83+
```
6384

64-
API Reference [here](https://xxfast.github.io/Decompose-Router//docs/)
85+
Read more
86+
- Documentation [here](https://xxfast.github.io/Decompose-Router/)
87+
- API Reference [here](https://xxfast.github.io/Decompose-Router//docs/)
6588

6689
## Licence
6790

68-
Copyright 2023 Isuru Rajapakse
91+
Copyright 2024 Isuru Rajapakse
6992

7093
Licensed under the Apache License, Version 2.0 (the "License");
7194
you may not use this file except in compliance with the License.

app/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ kotlin {
7777
implementation(compose.materialIconsExtended)
7878

7979
implementation(libs.decompose)
80-
implementation(libs.decompose.compose.multiplatform)
80+
implementation(libs.decompose.compose)
8181
}
8282
}
8383

@@ -104,7 +104,7 @@ kotlin {
104104
val desktopMain by getting {
105105
dependencies {
106106
implementation(compose.desktop.currentOs)
107-
implementation(libs.decompose.compose.multiplatform)
107+
implementation(libs.decompose.compose)
108108
implementation(libs.kotlinx.coroutines.swing)
109109
}
110110
}

decompose-router-wear/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ kotlin {
2525
implementation(libs.wear.compose.ui.tooling)
2626
implementation(libs.androidx.activity.compose)
2727
implementation(libs.decompose)
28-
implementation(libs.decompose.compose.multiplatform)
28+
implementation(libs.decompose.compose)
2929
}
3030
}
3131
}

decompose-router/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ kotlin {
4141

4242
implementation(compose.runtime)
4343
implementation(compose.foundation)
44-
implementation(libs.decompose.compose.multiplatform)
44+
implementation(libs.decompose.compose)
4545
implementation(libs.kotlinx.serialization.core)
4646
}
4747
}
@@ -68,7 +68,7 @@ kotlin {
6868
dependencies {
6969
implementation(compose.material3)
7070
implementation(libs.decompose)
71-
implementation(libs.decompose.compose.multiplatform)
71+
implementation(libs.decompose.compose)
7272
implementation(libs.androidx.activity.ktx)
7373
implementation(libs.androidx.activity.compose)
7474
implementation(libs.androidx.fragment.ktx)

docs/topics/installation.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,21 @@ repositories {
1111

1212
Include the dependency in `commonMain`. Latest version [![Maven Central](https://img.shields.io/maven-central/v/io.github.xxfast/decompose-router?color=blue)](https://search.maven.org/search?q=g:io.github.xxfast)
1313

14-
> **Note** - Check for compatible versions of Compose Multiplatform, Decompose and Essenty in the [Version Catalog]
14+
> **Note** - Check for compatible versions of Decompose and Compose in the [version catalog](https://github.com/xxfast/Decompose-Router/blob/main/gradle/libs.versions.toml)
1515
1616
## With version catalog
1717

1818
```toml
1919
[versions]
20-
# Check in gradle/libs.versions.toml
20+
decompose = "0.8.0"
21+
decompose = "3.0.0"
2122

2223
[libraries]
23-
# For Compose Multiplatform
24+
# For Jetpack Compose / Compose Multiplatform
2425
decompose-router = { module = "io.github.xxfast:decompose-router", version.ref = "decompose-router" }
2526

2627
# For Compose Wear
2728
decompose-router-wear = { module = "io.github.xxfast:decompose-router-wear", version.ref = "decompose-router" }
28-
29-
# You will need to also bring in decompose extensions for compose-multiplatform
30-
decompose-compose-multiplatform = { module = "com.arkivanov.decompose:extensions-compose-jetbrains", version.ref = "decompose" }
3129
```
3230

3331
**build.gradle.kts**
@@ -37,11 +35,6 @@ sourceSets {
3735
val commonMain by getting {
3836
dependencies {
3937
implementation(libs.decompose.router)
40-
41-
// You will probably need to also bring in decompose and essenty
42-
implementation(libs.decompose)
43-
implementation(libs.decompose.compose.multiplatform)
44-
implementation(libs.essenty.parcelable)
4538
}
4639
}
4740

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ compose-multiplatform = { module = "org.jetbrains.compose:compose-gradle-plugin"
2121
compose-ui-junit4 = { module = "androidx.compose.ui:ui-test-junit4", version.ref = "compose-test-rule" }
2222
compose-ui-test-manifest = { module = "androidx.compose.ui:ui-test-manifest", version.ref = "compose-test-rule" }
2323
decompose = { module = "com.arkivanov.decompose:decompose", version.ref = "decompose" }
24-
decompose-compose-multiplatform = { module = "com.arkivanov.decompose:extensions-compose", version.ref = "decompose" }
24+
decompose-compose = { module = "com.arkivanov.decompose:extensions-compose", version.ref = "decompose" }
2525
horologist-compose-layouts = { module = "com.google.android.horologist:horologist-compose-layout", version.ref = "horologist" }
2626
kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
2727
kotlinx-coroutines-swing = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-swing", version.ref = "kotlinx-coroutines" }

0 commit comments

Comments
 (0)