Skip to content

Commit 0f07db9

Browse files
authored
fix: Android getting started guide references outdated Maven artifact IDs (#911)
1 parent 2daa081 commit 0f07db9

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

guide/src/android-getting-started.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ We'll cover the "batteries included" approach, but flag areas for customization
1010
Let’s get started with Gradle setup.
1111
Replace `X.Y.Z` with the latest [release version](https://central.sonatype.com/namespace/com.stadiamaps.ferrostar).
1212

13+
The Android artifacts are split by responsibility:
14+
15+
- `core` contains the navigation engine bindings, location service APIs, and non-UI Android integration.
16+
- `ui-compose` contains reusable Jetpack Compose navigation UI components that are not tied to a map renderer.
17+
- `ui-maplibre` contains MapLibre-based map views and navigation UI.
18+
- `google-play-services` is optional and provides Google Play Services integrations, such as fused location.
19+
1320
#### `build.gradle` with explicit version strings
1421

1522
If you’re using the classic `build.gradle`
@@ -23,8 +30,8 @@ dependencies {
2330
// Ferrostar
2431
def ferrostarVersion = 'X.Y.Z'
2532
implementation "com.stadiamaps.ferrostar:core:${ferrostarVersion}"
26-
implementation "com.stadiamaps.ferrostar:maplibreui:${ferrostarVersion}"
27-
implementation "com.stadiamaps.ferrostar:composeui:${ferrostarVersion}"
33+
implementation "com.stadiamaps.ferrostar:ui-maplibre:${ferrostarVersion}"
34+
implementation "com.stadiamaps.ferrostar:ui-compose:${ferrostarVersion}"
2835
2936
// Optional - if using Google Play Service's FusedLocation
3037
implementation "com.stadiamaps.ferrostar:google-play-services:${ferrostarVersion}"
@@ -47,7 +54,8 @@ okhttp3 = "4.11.0"
4754

4855
[libraries]
4956
ferrostar-core = { group = "com.stadiamaps.ferrostar", name = "core", version.ref = "ferrostar" }
50-
ferrostar-maplibreui = { group = "com.stadiamaps.ferrostar", name = "maplibreui", version.ref = "ferrostar" }
57+
ferrostar-ui-maplibre = { group = "com.stadiamaps.ferrostar", name = "ui-maplibre", version.ref = "ferrostar" }
58+
ferrostar-ui-compose = { group = "com.stadiamaps.ferrostar", name = "ui-compose", version.ref = "ferrostar" }
5159
okhttp3 = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp3" }
5260
```
5361

@@ -59,7 +67,8 @@ dependencies {
5967
6068
// Ferrostar
6169
implementation libs.ferrostar.core
62-
implementation libs.ferrostar.maplibreui
70+
implementation libs.ferrostar.ui.maplibre
71+
implementation libs.ferrostar.ui.compose
6372
6473
// okhttp3
6574
implementation libs.okhttp3

0 commit comments

Comments
 (0)