[CM-1249] Documentation added. (#3)

* [CM-1249] Comments updated.

* [CM-1249] Read me file updated.

* [CM-1249] Read me file updated.

* Update documentation

* Add banner image

---------

Co-authored-by: Mark Pospesel <mark.pospesel@ymedialabs.com>

README.md

@@ -1,2 +1,186 @@
-# yanalytics-pendo-ios
-Y—Analytics implementation for Pendo SDK
+![Y—Analytics Pendo](https://user-images.githubusercontent.com/1037520/231155485-30ab1c51-f067-498b-9cfd-20d7369c0637.jpeg)
+_A Pendo implementation of Y—Analytics' `AnalyticsEngine` protocol._
+
+This framework links the [Pendo iOS SDK](https://github.com/pendo-io/pendo-mobile-ios) to implement a Pendo version of [Y—Analytics](https://github.com/yml-org/yanalytics-ios)' `AnalyticsEngine` protocol.
+
+Licensing
+----------
+Y—Analytics Pendo is licensed under the [Apache 2.0 license](LICENSE).
+
+Pendo iOS SDK does not have any license listed on their [GitHub page](https://github.com/pendo-io/pendo-mobile-ios).
+
+Documentation
+----------
+
+Documentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/yanalytics-pendo-ios/
+
+Usage
+----------
+
+### `PendoAnalyticsEngine`
+
+`PendoAnalyticsEngine` implements the `AnalyticsEngine` protocol, and in its `track(event:)` method it maps the `AnalyticsEvent` enum to the appropriate Pendo methods.
+
+Internally the Pendo SDK is just using singleton objects, but the goal of Y—Analytics is to use Dependency Injection of a generic wrapper. This allows your project code to be loosely coupled to your choice of analytics provider. It also facilitates unit testing and a healthy app architecture.
+
+Just be aware that even if you declare multiple instances of `PendoAnalyticsEngine`, that they all reference the same Pendo SDK singleton.
+
+When unit testing various components of your project, you should inject an instance of `MockAnalyticsEngine` instead of the Pendo engine. This allows your unit tests to run without any Pendo dependency and allows you to verify which events are tracked and when.
+
+#### Simple use case: app key
+You may initialize `PendoAnalyticsEngine` by passing a Pendo app key.
+
+```swift
+import YAnalyticsPendo
+
+final class AppCoordinator {
+    let engine: AnalyticsEngine = {
+        let config = PendoAnalyticsConfiguration(appKey: "S3cr3t!")
+        return PendoAnalyticsEngine(configuration: config)
+    }()
+
+    func trackSomething(someData: [String: Any]?) {
+        engine.track(
+            event: .event(name: "Something", parameters: someData)
+        )
+    }
+}
+```
+
+#### Additional configuration options
+In addition to the required app key, `PendoAnalyticsConfiguration` can be initialized with the following additional parameters:
+
+1. mappings: information for mapping from `AnalyticsEvent` to Pendo events
+2. session data: starts a session with the specified account and visitor id's and associated data.
+3. debug mode: turn on/off debug mode
+
+```swift
+import YAnalyticsPendo
+
+final class AppCoordinator {
+    let mappings: [String: PendoEventMapping] = ...
+    let session: PendoSessionData = ...
+    let isDebugMode: Bool = false
+
+    let engine: AnalyticsEngine = {
+        let config = PendoAnalyticsConfiguration(
+            appKey: "S3cr3t!",
+            mappings: mappings,
+            sessionData: session,
+            debugMode: isDebugMode
+        )
+        return PendoAnalyticsEngine(configuration: config)
+    }()
+}
+```
+
+Dependencies
+----------
+
+Y—Analytics Pendo depends upon our [Y—Analytics](https://github.com/yml-org/yanalytics-ios) framework (which is also open source and Apache 2.0 licensed).
+
+Installation
+----------
+
+You can add Y—Analytics Pendo to an Xcode project by adding it as a package dependency.
+
+1. From the **File** menu, select **Add Packages...**
+2. Enter "[https://github.com/yml-org/yanalytics-pendo-ios](https://github.com/yml-org/yanalytics-pendo-ios)" into the package repository URL text field
+3. Click **Add Package**
+
+Contributing to Y—Analytics Pendo
+----------
+
+### Requirements
+
+#### SwiftLint (linter)
+```
+brew install swiftlint
+```
+
+#### Jazzy (documentation)
+```
+sudo gem install jazzy
+```
+
+### Setup
+
+Clone the repo and open `Package.swift` in Xcode.
+
+### Versioning strategy
+
+We utilize [semantic versioning](https://semver.org).
+
+```
+{major}.{minor}.{patch}
+```
+
+e.g.
+
+```
+1.0.5
+```
+
+### Branching strategy
+
+We utilize a simplified branching strategy for our frameworks.
+
+* main (and development) branch is `main`
+* both feature (and bugfix) branches branch off of `main`
+* feature (and bugfix) branches are merged back into `main` as they are completed and approved.
+* `main` gets tagged with an updated version # for each release
+
+### Branch naming conventions:
+
+```
+feature/{ticket-number}-{short-description}
+bugfix/{ticket-number}-{short-description}
+```
+e.g.
+```
+feature/CM-44-button
+bugfix/CM-236-textview-color
+```
+
+### Pull Requests
+
+Prior to submitting a pull request you should:
+
+1. Compile and ensure there are no warnings and no errors.
+2. Run all unit tests and confirm that everything passes.
+3. Check unit test coverage and confirm that all new / modified code is fully covered.
+4. Run `swiftlint` from the command line and confirm that there are no violations.
+5. Run `jazzy` from the command line and confirm that you have 100% documentation coverage.
+6. Consider using `git rebase -i HEAD~{commit-count}` to squash your last {commit-count} commits together into functional chunks.
+7. If HEAD of the parent branch (typically `main`) has been updated since you created your branch, use `git rebase main` to rebase your branch.
+    * _Never_ merge the parent branch into your branch.
+    * _Always_ rebase your branch off of the parent branch.
+
+When submitting a pull request:
+
+* Use the [provided pull request template](.github/pull_request_template.md) and populate the Introduction, Purpose, and Scope fields at a minimum.
+* If you're submitting before and after screenshots, movies, or GIF's, enter them in a two-column table so that they can be viewed side-by-side.
+
+When merging a pull request:
+
+* Make sure the branch is rebased (not merged) off of the latest HEAD from the parent branch. This keeps our git history easy to read and understand.
+* Make sure the branch is deleted upon merge (should be automatic).
+
+### Releasing new versions
+* Tag the corresponding commit with the new version (e.g. `1.0.5`)
+* Push the local tag to remote
+
+Generating Documentation (via Jazzy)
+----------
+
+You can generate your own local set of documentation directly from the source code using the following command from Terminal:
+```
+jazzy
+```
+This generates a set of documentation under `/docs`. The default configuration is set in the default config file `.jazzy.yaml` file.
+
+To view additional documentation options type:
+```
+jazzy --help
+```
+A GitHub Action automatically runs each time a commit is pushed to `main` that runs Jazzy to generate the documentation for our GitHub page at: https://yml-org.github.io/yanalytics-pendo-ios/

Tests/YAnalyticsPendoTests/Helpers/XCTestCase+AssertLogged.swift

@@ -1,6 +1,6 @@
 //
 //  XCTestCase+AssertLogged.swift
-//  YAnalyticsTests
+//  YAnalyticsPendo
 //
 //  Created by Mark Pospesel on 2/21/23.
 //  Copyright © 2023 Y Media Labs. All rights reserved.

Tests/YAnalyticsPendoTests/Helpers/XCTestCase+MemoryLeakTracking.swift

@@ -1,6 +1,6 @@
 //
 //  XCTestCase+MemoryLeakTracking.swift
-//  YAnalyticsTests
+//  YAnalyticsPendo
 //
 //  Created by Karthik K Manoj on 08/04/22.
 //  Copyright © 2023 Y Media Labs. All rights reserved.

Tests/YAnalyticsPendoTests/Mock/MockAnalyticsData.swift

@@ -1,9 +1,9 @@
 //
 //  MockAnalyticsData.swift
-//  MetisTests
+//  YAnalyticsPendo
 //
 //  Created by Mark Pospesel on 7/20/21.
-//  Copyright © 2021 Y Media Labs. All rights reserved.
+//  Copyright © 2023 Y Media Labs. All rights reserved.
 //
 
 import Foundation