Skip to content

Commit e52f7f7

Browse files
committed
docs: document navigation signals
1 parent dd80494 commit e52f7f7

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ This package allows you to send signals to [TelemetryDeck](https://telemetrydeck
1313
* [Custom User Identifiers](#custom-user-identifiers)
1414
* [Environment Parameters](#environment-parameters)
1515
* [Default Parameters](#default-parameters)
16-
* [Default prefix](#default-prefix)
16+
* [Default Prefix](#default-prefix)
17+
* [Navigation Signals](#navigation-signals)]
1718
* [Custom Telemetry](#custom-telemetry)
1819
* [Custom Logging](#custom-logging)
1920
* [Requirements](#requirements)
@@ -180,7 +181,7 @@ val builder = TelemetryDeck.Builder()
180181
.addProvider(provider)
181182
```
182183

183-
## Default prefix
184+
## Default Prefix
184185

185186
If you find yourself prepending the same prefix for to your custom signals or parameters,
186187
you can optionally configure `TelemetryDeck` to do this for you by activating our `DefaultPrefixProvider`:
@@ -197,6 +198,19 @@ val builder = TelemetryDeck.Builder()
197198
.addProvider(provider)
198199
```
199200

201+
## Navigation Signals
202+
203+
You can make use of [Navigation Signals](https://telemetrydeck.com/docs/articles/navigation-signals/) to better understand how your users a moving through the app.
204+
205+
```kotlin
206+
// track a navigation event e.g. when the user is moving from one screen to another:
207+
TelemetryDeck.navigate(sourcePath = "/onboarding", destinationPath = "/home")
208+
209+
// let TelemetryDeck take care of tracking the user's route by calling navigate when the path changes
210+
TelemetryDeck.navigate("/onboarding")
211+
TelemetryDeck.navigate("/home")
212+
```
213+
200214
## Custom Telemetry
201215

202216
Another way to send signals is to implement a custom `TelemetryDeckProvider`.

0 commit comments

Comments
 (0)