Skip to content

Commit

Permalink
Fix readme links (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
prayansh authored May 5, 2021
1 parent 81153d6 commit 26f417b
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ to try out this new library. Please provide feedback via Github issues/PRs, and
supplant our `analytics-android` library.

## Table of Contents
- Installation (#installation)
- Usage (#usage)
- Setting up the client (#setting-up-the-client)
- Client Options (#client-options)
- Client Methods (#client-methods)
- [Installation](#installation)
- [Usage](#usage)
- [Setting up the client](#setting-up-the-client)
- [Client Options](#client-options)
- [Client Methods](#client-methods)
- track
- identify
- screen
Expand All @@ -19,12 +19,12 @@ supplant our `analytics-android` library.
- find
- remove
- flush
- Plugin Architecture (#plugin-architecture)
- Fundamentals (#fundamentals)
- Advanced Concepts (#advanced-concepts)
- Contributing (#contributing)
- Code of Conduct (#code-of-conduct)
- License (#license)
- [Plugin Architecture](#plugin-architecture)
- [Fundamentals](#fundamentals)
- [Advanced Concepts](#advanced-concepts)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Installation
In your app's build.gradle file add the following
Expand Down Expand Up @@ -61,7 +61,7 @@ Analytics("SEGMENT_API_KEY")
```

### Client Options
When creating a new client, you can pass several options which can be found below.
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.

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

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

- [`EventPlugin`]()
- [`EventPlugin`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt)
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.
For example if you only wanted to act on `track` & `identify` events
```kotlin
Expand All @@ -288,7 +288,7 @@ class SomePlugin: EventPlugin {
}
```

- [`DestinationPlugin`]()
- [`DestinationPlugin`](https://github.com/segmentio/analytics-kotlin/blob/main/analytics-kotlin/src/main/java/com/segment/analytics/platform/Plugin.kt)
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,
allowing you to modify/augment how events reach the particular destination.
For example if you wanted to implement a device-mode destination plugin for Amplitude
Expand All @@ -312,9 +312,9 @@ class AmplitudePlugin: DestinationPlugin() {


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

0 comments on commit 26f417b

Please sign in to comment.