Update README.md (#2)

* Update README.md

* Minor fixes for CI

Co-authored-by: Brandon Sneed <[email protected]>

Example/BasicExample/BasicExample.xcodeproj/project.pbxproj

@@ -604,8 +604,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/segmentio/analytics-swift";
 			requirement = {
-				branch = main;
-				kind = branch;
+				kind = upToNextMajorVersion;
+				minimumVersion = 1.1.2;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

Example/BasicExample/BasicExample.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -5,9 +5,9 @@
         "package": "Segment",
         "repositoryURL": "https://github.com/segmentio/analytics-swift",
         "state": {
-          "branch": "main",
-          "revision": "9c7dff28353e8942c7bc3aa83a7ddbc4e2f763b7",
-          "version": null
+          "branch": null,
+          "revision": "76316a5009502de6e7c2788c295e9afc68793cd3",
+          "version": "1.1.2"
         }
       },
       {

README.md

@@ -1,25 +1,81 @@
-# Swift Destination Plugin Template
-This template is resolved around `ExampleDestination` (to be replaced by you). 
+# Analytics-Swift Amplitude
 
-## What does the template provide
-### Data class for holding settings
-To standardize fetching and using settings in your destination, we recommend using a Coable class to store your destination settings. If marked `Codable`, it will enable you to retrieve your destination settings in a strongly typed construct.
+Add Amplitude session tracking support to your applications via this plugin for [Analytics-Swift](https://github.com/segmentio/analytics-swift)
 
-### Settings-related functions
-We provide APIs to update your destination settings in `update(settings:type:)`.
-`UpdateType.initial` lets you know if this is the intial or subsequent fetch.
+Note that this plugin simply adds session data for Amplitude, and events are sent via Cloud Mode.
 
-`Settings.isDestinationEnabled(key: String)`
-- check if your destination is enabled
+## Adding the dependency
 
-`Settings.integrationSettings(forKey: String)`
-- retrieve a typed destination object
+### via Xcode
+In the Xcode `File` menu, click `Add Packages`.  You'll see a dialog where you can search for Swift packages.  In the search field, enter the URL to this repo.
 
-### Sample implementation for common destination functions
-We have templated common destinations functions like `track`, `identify`, `screen`, `group`, `alias` that you should modify to fit your vendor SDK implementation. Although these functions do not need to return the ending payload, its good practice to do so (for unit testing purposes).
+https://github.com/segment-integrations/analytics-swift-amplitude
 
-### Transforming events
-Often times, destinations need to transform events (eg: change names, modify properties/traits etc.). We have templated an example of transformation in the `track(event:)` example. we recommend you use this approach to perform any such transformations. This will make your code more legible plus improve code quality.
+You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to.  Once you've made your selections, click the `Add Package` button.  
 
-### Testing functions for primary functions (to be expanded)
-We have provided a very bare minimum template for testing the primary destination APIs. We recommend to use this as a starter and build upon it to get test coverage of most scenarios.
+### via Package.swift
+
+Open your Package.swift file and add the following do your the `dependencies` section:
+
+```
+.package(
+            name: "Segment",
+            url: "https://github.com/segment-integrations/analytics-swift-amplitude.git",
+            from: "1.1.3"
+        ),
+```
+
+
+## Using the Plugin in your App
+
+Open the file where you setup and configure the Analytics-Swift library.  Add this plugin to the list of imports.
+
+```
+import Segment
+import SegmentAmplitude // <-- Add this line
+```
+
+Just under your Analytics-Swift library setup, call `analytics.add(plugin: ...)` to add an instance of the plugin to the Analytics timeline.
+
+```
+let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
+                    .flushAt(3)
+                    .trackApplicationLifecycleEvents(true))
+analytics.add(plugin: AmplitudeSession())
+```
+
+Your events will now be given Amplitude session data and start flowing to Amplitude via Cloud Mode.
+
+
+## Support
+
+Please use Github issues, Pull Requests, or feel free to reach out to our [support team](https://segment.com/help/).
+
+## Integrating with Segment
+
+Interested in integrating your service with us? Check out our [Partners page](https://segment.com/partners/) for more details.
+
+## License
+```
+MIT License
+
+Copyright (c) 2021 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```