Skip to content

Commit e03bc3f

Browse files
Fix links, touch up docs (#8)
1 parent b067032 commit e03bc3f

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ supplant our `analytics-ios` library, but customers should not use this library
77
The hassle-free way to add Segment analytics to your Swift app (iOS/tvOS/watchOS/macOS/Linux).
88

99
## Table of Contents
10-
- Installation (#installation)
11-
- Usage (#usage)
12-
- Setting up the client (#setting-up-the-client)
13-
- Client Options (#client-options)
14-
- Client Methods (#client-methods)
15-
- track
16-
- identify
17-
- screen
18-
- group
19-
- add
20-
- find
21-
- remove
22-
- flush
23-
- Plugin Architecture (#plugin-architecture)
24-
- Fundamentals (#fundamentals)
25-
- Advanced Concepts (#advanced-concepts)
26-
- Contributing (#contributing)
27-
- Code of Conduct (#code-of-conduct)
28-
- License (#license)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Setting up the client](#setting-up-the-client)
13+
- [Client Options](#client-options)
14+
- [Client Methods](#client-methods)
15+
- [track](#track)
16+
- [identify](#identify)
17+
- [screen](#screen)
18+
- [group](#group)
19+
- [add](#add)
20+
- [find](#find)
21+
- [remove](#remove)
22+
- [flush](#flush)
23+
- [Plugin Architecture](#plugin-architecture)
24+
- [Fundamentals](#fundamentals)
25+
- [Advanced Concepts](#advanced-concepts)
26+
- [Contributing](#contributing)
27+
- [Code of Conduct](#code-of-conduct)
28+
- [License](#license)
2929

3030
## Installation
3131
Add the Swift package as a dependency either via your package.swift, or via Xcode's File->Swift Packages->Add Package Dependency menu item.
@@ -206,9 +206,15 @@ analytics.remove("SomePlugin")
206206
```
207207

208208
### flush
209+
flushes the current queue of events
210+
211+
Example Usage:
212+
```swift
213+
analytics.flush()
214+
```
209215

210216
## Plugin Architecture
211-
Our new plugin architecture enables you to modify/augment how the analytics client works completely. From modifying event payloads to changing analytics functionality, Plugins are the easiest way to get things done
217+
Our new plugin architecture enables you to modify/augment how the analytics client works completely. From modifying event payloads to changing analytics functionality, plugins are the easiest way to get things done.
212218
Plugins are run through a timeline, which executes plugins in order of insertion based on their types.
213219
We have the following [types]
214220
- `before` _Executed before event processing begins_

0 commit comments

Comments
 (0)