Skip to content

Commit 26f417b

Browse files
authored
Fix readme links (#3)
1 parent 81153d6 commit 26f417b

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ to try out this new library. Please provide feedback via Github issues/PRs, and
66
supplant our `analytics-android` library.
77

88
## Table of Contents
9-
- Installation (#installation)
10-
- Usage (#usage)
11-
- Setting up the client (#setting-up-the-client)
12-
- Client Options (#client-options)
13-
- Client Methods (#client-methods)
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Setting up the client](#setting-up-the-client)
12+
- [Client Options](#client-options)
13+
- [Client Methods](#client-methods)
1414
- track
1515
- identify
1616
- screen
@@ -19,12 +19,12 @@ supplant our `analytics-android` library.
1919
- find
2020
- remove
2121
- flush
22-
- Plugin Architecture (#plugin-architecture)
23-
- Fundamentals (#fundamentals)
24-
- Advanced Concepts (#advanced-concepts)
25-
- Contributing (#contributing)
26-
- Code of Conduct (#code-of-conduct)
27-
- License (#license)
22+
- [Plugin Architecture](#plugin-architecture)
23+
- [Fundamentals](#fundamentals)
24+
- [Advanced Concepts](#advanced-concepts)
25+
- [Contributing](#contributing)
26+
- [Code of Conduct](#code-of-conduct)
27+
- [License](#license)
2828

2929
## Installation
3030
In your app's build.gradle file add the following
@@ -61,7 +61,7 @@ Analytics("SEGMENT_API_KEY")
6161
```
6262

6363
### Client Options
64-
When creating a new client, you can pass several options which can be found below.
64+
When creating a new client, you can pass several [options](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/Configuration.kt) which can be found below.
6565

6666
Android
6767
```kotlin
@@ -255,7 +255,7 @@ We have the following [types]
255255
### Fundamentals
256256
We have 3 types of basic plugins that you can use as a foundation for modifying functionality
257257

258-
- [`Plugin`]()
258+
- [`Plugin`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt)
259259
The most trivial plugin interface that will act on any event payload going through the timeline.
260260
For example if you wanted to add something to the context object of any event payload as an enrichment.
261261
```kotlin
@@ -272,7 +272,7 @@ class SomePlugin: Plugin {
272272
}
273273
```
274274

275-
- [`EventPlugin`]()
275+
- [`EventPlugin`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt)
276276
A plugin interface that will act only on specific event types. You can choose the event types by only overriding the event functions you want.
277277
For example if you only wanted to act on `track` & `identify` events
278278
```kotlin
@@ -288,7 +288,7 @@ class SomePlugin: EventPlugin {
288288
}
289289
```
290290

291-
- [`DestinationPlugin`]()
291+
- [`DestinationPlugin`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt)
292292
A plugin interface most commonly used for device-mode destinations. This plugin contains an internal timeline that follows the same process as the analytics timeline,
293293
allowing you to modify/augment how events reach the particular destination.
294294
For example if you wanted to implement a device-mode destination plugin for Amplitude
@@ -312,9 +312,9 @@ class AmplitudePlugin: DestinationPlugin() {
312312

313313

314314
### Advanced concepts
315-
- [`setup(Analytics)`]()
315+
- [`setup(Analytics)`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt#L20-L24)
316316
Use this function to setup your plugin. This will be implicitly called once the plugin is registered
317-
- [`update(Settings)`]()
317+
- [`update(Settings)`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt#L31-L33)
318318
Use this function to react to any settings updates. This will be implicitly called when settings are updated.
319319
You can force a settings update by calling `analytics.checkSettings()`
320320
- AndroidLifecycle hooks

0 commit comments

Comments
 (0)