Skip to content

Commit af86287

Browse files
committed
Update documentation
1 parent cb607f4 commit af86287

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ repositories {
7272
7373
```toml
7474
[versions]
75-
decompose-router = "0.8.0"
75+
decompose-router = "<version>"
7676

7777
[libraries]
7878
# For Jetpack Compose / Compose Multiplatform

docs/topics/installation.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,15 @@ repositories {
99
}
1010
```
1111

12-
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)
12+
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

1414
> **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-
decompose = "0.8.0"
21-
decompose = "3.0.0"
20+
decompose-router = "<version>"
2221

2322
[libraries]
2423
# For Jetpack Compose / Compose Multiplatform
@@ -55,19 +54,14 @@ sourceSets {
5554
// For Compose Multiplatform
5655
val commonMain by getting {
5756
dependencies {
58-
implementation("io.github.xxfast:decompose-router:${versions.decompose - router}")
59-
60-
// You will need to also bring in decompose and essenty
61-
implementation("com.arkivanov.decompose:decompose:${versions.decompose}")
62-
implementation("com.arkivanov.decompose:extensions-compose-jetbrains:${versions.decompose}")
63-
implementation("com.arkivanov.essenty:parcelable:${versions.essenty}")
57+
implementation("io.github.xxfast:decompose-router:${versions.decompose-router}")
6458
}
6559
}
6660

6761
// For Compose Wear
6862
val androidMain by getting {
6963
dependencies {
70-
implementation("io.github.xxfast:decompose-router-wear:${versions.decompose - router}")
64+
implementation("io.github.xxfast:decompose-router-wear:${versions.decompose-router}")
7165
}
7266
}
7367
}

docs/topics/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[![Kotlin Experimental](https://kotl.in/badges/experimental.svg)](https://kotlinlang.org/docs/components-stability.html)
66
[![Build](https://github.com/xxfast/Decompose-Router/actions/workflows/build.yml/badge.svg)](https://github.com/xxfast/Decompose-Router/actions/workflows/build.yml)
7-
[![Kotlin](https://img.shields.io/badge/Kotlin-1.9.10-blue.svg?style=flat&logo=kotlin)](https://kotlinlang.org)
7+
[![Kotlin](https://img.shields.io/badge/Kotlin-2.0.0-blue.svg?style=flat&logo=kotlin)](https://kotlinlang.org)
88
[![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)
99

1010
![badge-android](http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat)

docs/topics/platform-configurations.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ class UIKitAppDelegate: UIResponder, UIApplicationDelegate {
165165
## Web
166166
Create your default RouterContext once and supply with `CompositionLocalProvider`
167167
168+
### JsBrowser
168169
```kotlin
169170
fun main() {
170171
val rootRouterContext: RouterContext = defaultRouterContext()
@@ -180,3 +181,18 @@ fun main() {
180181
}
181182
}
182183
```
184+
185+
### WasmJsBrowser
186+
```kotlin
187+
fun main() {
188+
val rootRouterContext: RouterContext = defaultRouterContext()
189+
190+
BrowserViewportWindow("App") {
191+
CompositionLocalProvider(LocalRouterContext provides rootRouterContext) {
192+
MaterialTheme {
193+
// Your app goes here
194+
}
195+
}
196+
}
197+
}
198+
```

0 commit comments

Comments
 (0)