-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from aminekarimii/aminekarimii-patch-1
Update README.md
- Loading branch information
Showing
4 changed files
with
113 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
|
|
||
| <h1 align="center">Google/Firebase Add-on implementation</h1></br> | ||
| <p align="center"> | ||
| <img src="https://github.com/aminekarimii/analytiks/assets/20410115/c16c3495-bb8e-4002-8cfe-bb68e3f82761" width="20%" /> | ||
| </p> | ||
|
|
||
| ## Configuration | ||
| | Field Name | Description | Default Value | | ||
| |------------------------------|----------------------------------------------------|------------------| | ||
| | isAnalyticsCollectionEnabled | Indicates whether analytics collection is enabled. | true | | ||
| | sessionTimeoutDuration | Duration of the session timeout in milliseconds. | null | | ||
| | defaultEventParameters | Default event parameters for tracking events. | null | | ||
|
|
||
| Note: The default values mentioned above can be overridden by providing custom values during initialization. | ||
| ## Create Add-on | ||
| 1. Download Google analytics add-on: | ||
| ```gradle | ||
| implementation 'com.github.aminekarimii.analytiks:analytiks-googleanalytics:0.1.0-beta' | ||
| ``` | ||
| 2. Create your own client | ||
| ``` kotlin | ||
| val googleAnalytics = GoogleAnalyticsClient( | ||
| isAnalyticsCollectionEnabled = true, | ||
| sessionTimeoutDuration = 300L, | ||
| defaultEventParameters = null | ||
| ) | ||
| ``` | ||
|
|
||
| ### Check the official documentation for more details: | ||
| ➡️ [Official firebase analytics](https://firebase.google.com/docs/analytics/get-started?platform=android) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
|
|
||
| <h1 align="center">Mixpanel Add-on implementation</h1></br> | ||
| <p align="center"> | ||
| <img src="https://github.com/aminekarimii/analytiks/assets/20410115/f5b648d4-529a-4309-8e9d-2409b47457da" width="20%" /> | ||
| </p> | ||
|
|
||
| ## Configuration | ||
| | Field Name | Description | Default Value | | ||
| |-----------------------|---------------------------------------------------------------------|----------------------| | ||
| | token | The token used for tracking events. | - | | ||
| | optOutTrackingDefault | Determines whether tracking is enabled by default for new users. | false | | ||
| | superProperties | Additional properties to be included with every tracked event. | null | | ||
| | instanceName | A custom name for the analytics instance (optional). | null | | ||
| | trackAutomaticEvents | Controls automatic event tracking (e.g., screen views, app opens). | true | | ||
|
|
||
| Note: The default values mentioned above can be overridden by providing custom values during initialization. | ||
| ## Create Add-on | ||
| 1. Download Mixpanel add-on: | ||
| ```gradle | ||
| implementation 'com.github.aminekarimii.analytiks:analytiks-mixpanel:0.1.0-beta' | ||
| ``` | ||
| 2. Create your own mixpanel client | ||
| ``` kotlin | ||
| val mixpanel = MixpanelAnalyticsClient( | ||
| token: "YOUR_TOKEN", | ||
| optOutTrackingDefault: = false, | ||
| trackAutomaticEvents = true | ||
| ) | ||
| ``` | ||
|
|
||
| ### Check the official documentation for more details: | ||
| ➡️ [Official documentation](https://developer.mixpanel.com/docs/android) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <h1 align="center">Segment Add-on implementation</h1></br> | ||
| <p align="center"> | ||
| <img src="https://github.com/aminekarimii/analytiks/assets/20410115/6f8072f2-ca92-43a9-a974-dd0627c554c3" width="20%" /> | ||
| </p> | ||
|
|
||
| ## Configuration | ||
| | Field Name | Description | Default Value | | ||
| |---------------------------------|---------------------------------------------------------------------------------|---------------| | ||
| | token | The token used for tracking events. | - | | ||
| | collectDeviceId | Determines whether to collect the device ID. | true | | ||
| | trackApplicationLifecycleEvents | Controls automatic tracking of application lifecycle events. | false | | ||
| | useLifecycleObserver | Determines whether to use the Lifecycle Observer for event tracking. | false | | ||
| | flushIntervalInSeconds | The time interval (in seconds) for flushing queued events to the server. | null | | ||
| | flushAt | The maximum number of events to be queued before flushing to the server. | null | | ||
| | tag | A custom tag to identify the analytics instance (optional). | null | | ||
|
|
||
| Note: The default values mentioned above can be overridden by providing custom values during initialization. | ||
|
|
||
| ## Create Add-on | ||
| 1. Download Segment add-on: | ||
| ```gradle | ||
| implementation 'com.github.aminekarimii.analytiks:analytiks-segment:0.1.0-beta' | ||
| ``` | ||
| 2. Create your own Segment client: | ||
| ``` kotlin | ||
| val segment = SegmentAnalyticsClient( | ||
| token = "YOUR_TOKEN", | ||
| collectDeviceId = true, | ||
| trackApplicationLifecycleEvents = false, | ||
| useLifecycleObserver = false, | ||
| flushIntervalInSeconds = null, | ||
| flushAt = null, | ||
| tag = null | ||
| ) | ||
| ``` | ||
|
|
||
| ### Check the official documentation for more details: | ||
| ➡️ [Official documentation](https://segment.com/docs/sources/mobile/android/) | ||
|
|
||
| Feel free to customize the content and formatting as per your preferences. |