Skip to content

Commit 0e12a7e

Browse files
authored
edits
1 parent b2da388 commit 0e12a7e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/connections/auto-instrumentation/kotlin-setup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ Segment’s Signals library powers [Auto-Instrumentation](/docs/connections/auto
77

88
This guide shows how to install and configure the library, as well as how to enable optional plugins for screen views, network activity, and more.
99

10-
> info "Public Beta"
10+
> info "Auto-Instrumentation in public beta"
1111
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
1212
1313
## Before you begin
1414

1515
To use Signals with Android, you need:
1616

17-
- An active Segment workspace with Auto-Instrumentation enabled
18-
- A Kotlin-based Android project
19-
- Android Gradle Plugin version 7.0 or later
20-
- A minimum compile SDK version of 21
17+
- An active Segment workspace with Auto-Instrumentation enabled.
18+
- A Kotlin-based Android project.
19+
- Android Gradle Plugin version 7.0 or later.
20+
- A minimum compile SDK version of 21.
2121

22-
Signals supports [Jetpack Compose](https://developer.android.com/compose){:target="_blank"} and traditional Android UI frameworks. It also includes optional plugins for network tracking using [OkHttp3](https://square.github.io/okhttp/){:target="_blank"}, [Retrofit](https://square.github.io/retrofit/){:target="_blank"}, or `HttpURLConnection`](https://developer.android.com/reference/java/net/HttpURLConnection){:target="_blank"}.
22+
Signals supports [Jetpack Compose](https://developer.android.com/compose){:target="_blank"} and traditional Android UI frameworks. It also includes optional plugins for network tracking using [OkHttp3](https://square.github.io/okhttp/){:target="_blank"}, [Retrofit](https://square.github.io/retrofit/){:target="_blank"}, or [`HttpURLConnection`](https://developer.android.com/reference/java/net/HttpURLConnection){:target="_blank"}.
2323

2424
Segment recommends testing in a development environment before deploying Signals in production. For more information, see [Debug mode](#step-4-enable-debug-mode).
2525

@@ -63,7 +63,7 @@ Only add the plugins you plan to use. You can add or remove them later without r
6363

6464
## Step 2: Initialize the SDK
6565

66-
After you add dependencies, you'll need to initialize the Analytics client and configure the Signals plugin.
66+
After you add dependencies, you need to initialize the Analytics client and configure the Signals plugin.
6767

6868
Start by creating the `Analytics` instance using your source's write key. Then add the Signals plugin and configure its settings separately.
6969

@@ -95,7 +95,7 @@ navController.turnOnScreenTracking()
9595

9696
When you run this code, keep the following in mind:
9797

98-
- You'll need to replace `<WRITE_KEY>` with the key from your Android Source in Segment.
98+
- You need to replace `<WRITE_KEY>` with the key from your Android Source in Segment.
9999
- `debugMode` sends signals to Segment for use in the Event Builder. Only enable it in development environments.
100100
- If your app doesn't use Jetpack Compose or Navigation, you can skip those plugin lines.
101101

@@ -230,7 +230,7 @@ If `debugMode` is enabled, Signals appear in real time as you interact with the
230230
5. After you add any event mappings, click **Publish event rules** to save them.
231231

232232
> info "What if I don't see the Event Builder tab?"
233-
> If you don't see the Event Builder tab, confirm that the SDK is installed correctly and make sure `debugMode` is enabled. Verify that Auto Instrumentation is enabled in **Settings > Advanced**. If you still don't see it, reach out to your CSM.
233+
> If you don't see the Event Builder tab, confirm that the SDK is installed correctly and make sure `debugMode` is enabled. Verify that Auto-Instrumentation is enabled in **Settings > Advanced**. If you still don't see it, reach out to your CSM.
234234
235235
## Configuration options
236236

0 commit comments

Comments
 (0)