Skip to content

Commit ec2ffd1

Browse files
committed
Use the full project name in prose
1 parent a3209ee commit ec2ffd1

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# compose-nav-graph - Changelog
1+
# Compose Navigation Graph - Changelog
22

33
All notable changes to this project will be documented in this file.
44

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ The full guide, including multi module baselines and CI integration, lives in th
255255

256256
## Kotlin Multiplatform Support
257257

258-
compose-nav-graph works on **Kotlin Multiplatform** out of the box: the annotations live in `commonMain` (published
258+
Compose Navigation Graph works on **Kotlin Multiplatform** out of the box: the annotations live in `commonMain` (published
259259
for `android`, `jvm`, `iosArm64`/`iosSimulatorArm64`/`iosX64`, `js`, and `wasmJs`), and the Gradle plugin detects your
260260
module shape and wires the right KSP pass automatically:
261261

docs/gradle-plugin/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
The compose-nav-graph Gradle plugin (`com.github.skydoves.navgraph`) wires the whole toolkit into your build. When applied, it adds the `compose-nav-graph-annotations` and `compose-nav-graph-ksp` dependencies, registers the KSP processor that statically extracts your nav graph, sets up device free thumbnail rendering, and registers the nav tasks (`generateNavGraph`, `navDump` / `navCheck`, the HTML and PNG exports, and the preview gallery). It supports Kotlin Multiplatform and multi module projects.
3+
The Compose Navigation Graph Gradle plugin (`com.github.skydoves.navgraph`) wires the whole toolkit into your build. When applied, it adds the `compose-nav-graph-annotations` and `compose-nav-graph-ksp` dependencies, registers the KSP processor that statically extracts your nav graph, sets up device free thumbnail rendering, and registers the nav tasks (`generateNavGraph`, `navDump` / `navCheck`, the HTML and PNG exports, and the preview gallery). It supports Kotlin Multiplatform and multi module projects.
44

55
The toolkit is not tied to Navigation 3. **Navigation 3 `NavKey` destinations are picked up automatically**, and any other class wires in through the annotations: Navigation 2 routes, or even plain Activities referenced by `@NavEdge` or `@NavPreview`, become nodes without implementing `NavKey`. An existing app lights up without refactoring.
66

docs/kotlin-multiplatform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Kotlin Multiplatform
22

3-
compose-nav-graph supports **Kotlin Multiplatform** out of the box. The annotations are a KMP library that lives in
3+
Compose Navigation Graph supports **Kotlin Multiplatform** out of the box. The annotations are a KMP library that lives in
44
your `commonMain` source set (published for `android`, `jvm`, `iosArm64` / `iosSimulatorArm64` / `iosX64`, `js`, and
55
`wasmJs`), and the Gradle plugin detects your module's shape and wires the right KSP pass for you. There is no
66
KMP specific configuration: you apply the same two plugins as on a plain Android module.

0 commit comments

Comments
 (0)