Merge pull request #38 from aminekarimii/aminekarimii-patch-3

Update README.md

README.md

@@ -80,21 +80,22 @@ The list of features provided by the library
 - **Reset:** `reset` the plugins and remove the default users configuration.
 - **Flush events** `flush` send the recorded local data to the service servers on call.
 
-## Supported analytics SDKs
-
-Here's a list of the most known Analytic services that we will supoort in our library.
-
-- [x] Google/Firebase Analytics
-- [x] Segment
-- [x] Mixpanel
-- [ ] Flurry Analytics
-- [ ] Amplitude
-- [ ] App Annie
-- [ ] Localytics
-- [ ] AppsFlyer
-- [ ] Sensor Tower
-- [ ] Onesignal
-- [x] Timber - For local event logging
+## 🗃 Supported analytics SDKs
+Here's a list of the most known analytics services that we will support in our library.  
+| Service   |     Status    | Implementation | Official documentation |
+| --------- | ------------- | -------------- | ------------ |
+| Google/Firebase Analytics  | ✅  | <a href="./addon/analytiks-googleanalytics/README.md">Firebase/Google Addon doc</a>  | <a href="https://firebase.google.com/docs/analytics/get-started?platform=android">Firebase Analytics doc</a> |
+| Segment  | ✅  | <a href="./addon/analytiks-segment/README.md">Segment Addon doc</a> | <a href="https://segment.com/docs/connections/sources/catalog/libraries/mobile/kotlin-android/" >Segment doc</a> |
+| Mixpanel  | ✅  | <a href="./addon/analytiks-mixpanel/README.md">Mixpanel Addon doc</a>| <a href="https://developer.mixpanel.com/docs/android">Mixpanel doc</a> |
+| Flurry Analytics  | 🚧  | - | - |
+| Amplitude  | ✅ | <a href="./addon/analytiks-amplitude/README.md">Amplitude Addon doc</a> | <a href="https://www.docs.developers.amplitude.com/data/sdks/sdk-quickstart/">Amplitude doc</a> |
+| App Annie  | 🚧  | - | - |
+| Localytics  | 🚧  | - | - |
+| AppsFlyer  | 🚧  | - | - |
+| App Center Analytics  | 🚧  | - | - |
+| Onesignal  | 🚧  | - | - |
+| Timber - For local event logging  | ✅  | - | <a href="https://github.com/JakeWharton/timber">github/JakeWharton/timber</a> | 
+| Your Custom Addon  | ✅  | - | <a href="./analytiks-core">Instructions</a> |
 
 ➕ Can't find your service? [open an issue](https://github.com/aminekarimii/analytiks/issues/new) with the name and the direct documentation link in the comment section.
 

addon/analytiks-amplitude/README.md

@@ -0,0 +1,32 @@
+
+<h1 align="center">Amplitude Add-on implementation</h1></br>
+<p align="center">
+   <img src="https://github.com/aminekarimii/analytiks/assets/20410115/1f330afd-c805-4d54-9b74-654192f019b3" width="25%" />
+</p>
+
+## Configuration
+| Field Name                 | Description                                    | Default Value |
+|----------------------------|------------------------------------------------|---------------|
+| token                      | The token used for tracking events.            | -             |
+| serverGeoZone              | The server geo zone for Amplitude server.      | ServerGeoZone.EU |
+| optOut                     | Indicates whether opt-out is enabled.         | false         |
+| minTimeBetweenSessionsMillis | Minimum time between sessions in milliseconds. | 10000         |
+
+Note: The default values mentioned above can be overridden by providing custom values during initialization.
+## Create Add-on
+1. Download Amplitude analytics add-on:
+```gradle
+implementation 'io.github.aminekarimii:analytiks-amplitude:1.0.0'
+```
+2. Create your own client:
+``` kotlin
+class AmplitudeClient(
+    token: "TOUR_TOKEN",
+    serverGeoZone = ServerGeoZone.EU,
+    optOut = false,
+    minTimeBetweenSessionsMillis = 10000
+)
+```
+
+### Check the official documentation for more details: 
+➡️ [Official amplitude analytics](https://www.docs.developers.amplitude.com/data/sdks/sdk-quickstart/)

addon/analytiks-googleanalytics/README.md

@@ -15,7 +15,7 @@ Note: The default values mentioned above can be overridden by providing custom v
 ## Create Add-on
 1. Download Google analytics add-on:
 ```gradle
-implementation 'com.github.aminekarimii.analytiks:analytiks-googleanalytics:0.1.0-beta'
+implementation 'io.github.aminekarimii:analytiks-googleanalytics:1.0.0'
 ```
 2. Create your own client
 ``` kotlin

addon/analytiks-mixpanel/README.md

@@ -17,7 +17,7 @@ Note: The default values mentioned above can be overridden by providing custom v
 ## Create Add-on
 1. Download Mixpanel add-on:
 ```gradle
-implementation 'com.github.aminekarimii.analytiks:analytiks-mixpanel:0.1.0-beta'
+implementation 'io.github.aminekarimii:analytiks-mixpanel:1.0.0'
 ```
 2. Create your own mixpanel client
 ``` kotlin

addon/analytiks-segment/README.md

@@ -19,7 +19,7 @@ Note: The default values mentioned above can be overridden by providing custom v
 ## Create Add-on
 1. Download Segment add-on:
 ```gradle
-implementation 'com.github.aminekarimii.analytiks:analytiks-segment:0.1.0-beta'
+implementation 'io.github.aminekarimii:analytiks-segment:1.0.0'
 ```
 2. Create your own Segment client:
 ``` kotlin