Skip to content

Update README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2021
Merged

Update README #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 26 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ supplant our `analytics-ios` library, but customers should not use this library
The hassle-free way to add Segment analytics to your Swift app (iOS/tvOS/watchOS/macOS/Linux).

## Table of Contents
- Installation (#installation)
- Usage (#usage)
- Setting up the client (#setting-up-the-client)
- Client Options (#client-options)
- Client Methods (#client-methods)
- track
- identify
- screen
- group
- add
- find
- remove
- flush
- Plugin Architecture (#plugin-architecture)
- Fundamentals (#fundamentals)
- Advanced Concepts (#advanced-concepts)
- Contributing (#contributing)
- Code of Conduct (#code-of-conduct)
- License (#license)
- [Installation](#installation)
- [Usage](#usage)
- [Setting up the client](#setting-up-the-client)
- [Client Options](#client-options)
- [Client Methods](#client-methods)
- [track](#track)
- [identify](#identify)
- [screen](#screen)
- [group](#group)
- [add](#add)
- [find](#find)
- [remove](#remove)
- [flush](#flush)
- [Plugin Architecture](#plugin-architecture)
- [Fundamentals](#fundamentals)
- [Advanced Concepts](#advanced-concepts)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

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

### flush
flushes the current queue of events

Example Usage:
```swift
analytics.flush()
```

## Plugin Architecture
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
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.
Plugins are run through a timeline, which executes plugins in order of insertion based on their types.
We have the following [types]
- `before` _Executed before event processing begins_
Expand Down