Skip to content

Commit e595a8d

Browse files
authored
Update README.md
1 parent 62c8c1b commit e595a8d

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A Flutter library for custom analytics management, designed to streamline integr
66

77
- **Custom Event Tracking**: Easily log and manage events in your application.
88
- **Screen View Logging**: Track screen views to gain insights into user navigation.
9-
- ** **Funnels Manager**: Tracks the time it takes the users go through a journey in our app.
9+
- **Funnels Manager**: Tracks the time it takes the users go through a journey in our app.
1010
- **Robust Reporting**: Access detailed reports on user interactions and events.
1111

1212
## Getting Started
@@ -94,31 +94,44 @@ class _SimpleEventExampleScreenState extends State<SimpleEventExampleScreen> {
9494
## Funnels Manager
9595

9696
### Purpose
97-
The `FunnelsManager` is a tool designed to track the sequence of user interactions or events in a specific flow, commonly referred to as a "funnel." A funnel is a defined series of steps that a user follows, and by tracking how users interact with these steps, you can gather insights on engagement, abandonment points, and overall user behavior.
97+
The `FunnelsManager` is a tool designed to track the sequence of user interactions or events in a specific flow, commonly referred to as a "funnel".
98+
99+
A funnel is a defined series of steps that a user follows, and by tracking how users interact with these steps, you can gather insights on engagement, abandonment points, and overall user behavior.
98100

99101
### Implementation
100102

101103
1. **Create and Start a Funnel**
102-
To start tracking a funnel, you need to define a funnel using the `AnalytixFunnel` class and register it with the `FunnelsManager`. Here’s an example of how to start a funnel:
104+
To start tracking a funnel, you need to define a funnel using the `AnalytixFunnel` class and register it with the `FunnelsManager`.
105+
Here’s an example of how to start a funnel:
103106

104-
```dart
107+
```dart
105108
FunnelsManager().start(AnalytixFunnel(Funnels.funnel_2, shouldCountTime: true));
106-
```
107-
• Funnels.funnel_2 is the name of the funnel you’re tracking.
108-
• The shouldCountTime flag tracks the time a user spends on each step of the funnel.
109+
```
110+
111+
• Funnels.funnel_2 is the name of the funnel you’re tracking.
112+
113+
• The shouldCountTime flag tracks the time a user spends on each step of the funnel.
114+
115+
109116
2. **Tracking Events in the Funnel**
110117
After starting the funnel, you can track specific events or steps within the funnel. For example:
111-
```dart
118+
119+
```dart
112120
FunnelsManager().track(Funnels.funnel_3, "step_1");
113-
```
121+
```
122+
114123
This code logs the event "step_1" within the funnel_3.
124+
115125
3. **Finishing a Funnel**
116-
Once the funnel is complete (i.e., when the user completes all the steps), make sure to finish the funnel to capture the final event and any time-related data:
117-
```dart
126+
Once the funnel is complete (i.e., when the user completes all the steps), make sure to finish the funnel to capture the final event and any time-related data:
127+
128+
```dart
118129
FunnelsManager().finish(Funnels.funnel_2, "finish");
119-
```
130+
```
120131
This marks the funnel as finished and logs the final event.
121132

133+
## More
134+
122135
For help getting started with Flutter development, view the online
123136
[documentation](https://flutter.dev/).
124137

0 commit comments

Comments
 (0)