improve docs around plugins and make things more accessible via links (#48)

Author: prayansh

README.md

@@ -49,6 +49,8 @@ NOTE: If you use pure Java codebase, please refer to [Java Compatibility](JAVA_C
 
 You can find usage documentation at [https://segment.com/docs/sources/mobile/kotlin-android/](https://segment.com/docs/sources/mobile/kotlin-android/).
 
+Explore more via the [example projects](samples) which showcase analytics instrumentation on different platforms/languages and usage of plugins. These projects contain sample [plugins](samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins) and [destination plugins](samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins) 
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

samples/README.md

@@ -0,0 +1,13 @@
+# Sample Projects using analytics-kotlin
+
+- [Java Android Application](java-android-app)
+  A sample project showcasing the usage of `analytics-kotlin` in a pure java codebase Android application
+
+- [Kotlin Android Application](kotlin-android-app)
+  A sample project showcasing the usage of `analytics-kotlin` in a pure kotlin codebase Android application. Also contains sample plugins that are commonly used.
+
+- [Kotlin Android Application w/ Sample Destination Plugins](kotlin-android-app-destinations)
+  A sample project showcasing the usage of `analytics-kotlin` in a pure kotlin codebase Android application. This project also hosts sample Destination plugins, and instructions on how to include them in your own projects
+
+- [Kotlin JVM Application](kotlin-jvm-app)
+  A sample project showcasing the usage of `analytics-kotlin` in a pure kotlin codebase JVM application.

samples/kotlin-android-app-destinations/README.md

@@ -2,17 +2,23 @@
 This is a sample android app that uses the `analytics-kotlin` library and the new `Plugins` concepts. It is meant to be simplistic, and easy to understand all the while showcasing the power of the analytics-kotlin library
 
 ## Plugins
-- [Amplitude Session](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/AmplitudeSession.kt)
+- [Amplitude Session](src/main/java/com/segment/analytics/destinations/plugins/AmplitudeSession.kt)
 Sample plugin to enable users to enrich data for the Amplitude Actions destination
 
-- [Firebase](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/FirebaseDestination.kt)
+- [AppsFlyer](src/main/java/com/segment/analytics/destinations/plugins/AppsflyerDestination.kt)
+Sample plugin to enable users to send data to the device-mode AppsFlyer destination
+
+- [Comscore](src/main/java/com/segment/analytics/destinations/plugins/ComscoreDestination.kt)
+Sample plugin to enable users to send data to the device-mode Comscore destination
+
+- [Firebase](src/main/java/com/segment/analytics/destinations/plugins/FirebaseDestination.kt)
 Sample plugin to enable users to send data to the device-mode Firebase destination 
 
-- [Intercom](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/IntercomDestination.kt)
+- [Intercom](src/main/java/com/segment/analytics/destinations/plugins/IntercomDestination.kt)
 Sample plugin to enable users to send data to the device-mode Intercom destination
 
-- [Mixpanel](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/MixpanelDestination.kt)
+- [Mixpanel](src/main/java/com/segment/analytics/destinations/plugins/MixpanelDestination.kt)
 Sample plugin to enable users to send data to the device-mode Mixpanel destination
 
-- [Webhook Plugin](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/WebhookPlugin.kt)
+- [Webhook Plugin](src/main/java/com/segment/analytics/destinations/plugins/WebhookPlugin.kt)
 An after plugin that allows you to send the event from the analytics timeline to a webhook of your choice. Ideal for debugging payloads in an internal network.

samples/kotlin-android-app/README.md

@@ -2,18 +2,18 @@
 This is a sample android app that uses the `analytics-kotlin` library and the new `Plugins` concepts. It is meant to be simplistic, and easy to understand all the while showcasing the power of the analytics-kotlin library
 
 ## Plugins
-- Android AdvertisingId Plugin
+- [Android AdvertisingId Plugin](src/main/java/com/segment/analytics/next/plugins/AndroidAdvertisingIdPlugin.kt)
 Using the `play-services-ads` library this plugin adds the `advertisingId` to all payloads (under the `context` key) going through the analytics timeline
 
-- Android Record Screen Plugin
+- [Android Record Screen Plugin](src/main/java/com/segment/analytics/next/plugins/AndroidRecordScreenPlugin.kt)
 Using the application lifecycle, this plugin automatically sends `Screen` events through the analytics timeline, on Activity start
 
-- Consent Tracking
+- [Consent Tracking](src/main/java/com/segment/analytics/next/plugins/ConsentTracking.kt)
 Presents user with a dialog to consent to tracking. If consent is given, any queued events will be sent out to the analytics timeline. If consent is not given, all queued events and future events will be dropped
 ** Note: You will have to switch to the `ConsentActivity` inside of AndroidManifest.xml to view this feature **
 
-- Webhook Plugin
-A destination plugin that allows you to send the event from the analytics timeline to a webhook of your choice. Ideal for debugging payloads in an internal network.
+- [Push Notification Tracking](src/main/java/com/segment/analytics/next/plugins/PushNotificationTracking.kt)
+Using Firebase Service for push notifications this plugin hooks into the activity start lifecycle method and fires Push Notification track events.
 
 ## Tracking Deep Links
 The sample app is configured to open links with the schema and hostname `https://segment-sample.com`
@@ -23,7 +23,7 @@ Here is how you can do it via adb
 adb shell am start -W -a android.intent.action.VIEW -d "https://segment-sample.com?utm_source=cli\&utm_click=2" com.segment.analytics.next
 ```
 
-## FCM
+## Firebase Cloud Messaging
 This project is setup to track push notification received and opened events. This code is strictly optional and must be customized as per your needs. The code here is only for demonstration purposes
 ### Setup
 - Add your FCM project's `google-services.json` to this folder

samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/PushNotificationTracking.kt

@@ -8,6 +8,14 @@ import com.segment.analytics.kotlin.android.plugins.AndroidLifecycle
 import kotlinx.serialization.json.buildJsonObject
 import kotlinx.serialization.json.put
 
+/**
+ * Used alongside with MyFirebaseService.kt
+ *
+ * Firebase Service handles the incoming push notification and fires the Push Notification Received event,
+ * if we choose to create a notification based on the incoming push, then this plugin will act upon the
+ * opening of that notification and fire the Push Notification Tapped event.
+ */
+
 object PushNotificationTracking: Plugin, AndroidLifecycle {
     override val type: Plugin.Type = Plugin.Type.Utility
     override lateinit var analytics: Analytics