Skip to content

docs: usage instruction #15

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

Open
reslear wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: usage instruction #15

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
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,29 @@ npx cap sync
- Capacitor 3 is recommended for this version
- Version 1.0.0 will target Capacitor 4

## Usage

First need initialize plugin with you [writeKey](https://segment.com/docs/connections/find-writekey/), and then use track methods:

```ts
import { Segment } from '@joinflux/capacitor-segment'

Segment.initialize({
key: 'you write key',
})

// see API section with other methods
Segment.track({ eventName: 'Hello World'})
```

For prevent crashing app in HMR on init hook, recommended handling exception:

```ts
await Segment.initialize({
// ...
}).catch((e) => console.error(e))
```

## API

<docgen-index>
Expand Down