adding new swift plugin docs for 1flow #5369
Merged
Conversation
This file contains hidden or 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
tcgilbert
commented
Sep 19, 2023
Comment on lines
17
to
57
| ## Adding the dependency | ||
|
|
||
| ### Through 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 repository. | ||
| ``` | ||
| https://github.com/1Flow-Inc/segment-1flow-ios.git | ||
| ``` | ||
|
|
||
|
|
||
| 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. | ||
|
|
||
| ### Through Package.swift | ||
|
|
||
| Open your Package.swift file and add the following to the `dependencies` section: | ||
|
|
||
| ``` | ||
| .package( | ||
| name: "Segment", | ||
| url: "https://github.com/1Flow-Inc/segment-1flow-ios.git", | ||
| from: "1.0.0" | ||
| ), | ||
| ``` | ||
|
|
||
| ## 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 SegmentOneFlow // <-- 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: OneFlowDestination()) | ||
| ``` |
There was a problem hiding this comment.
@rohantryskybox I have added this page as we provide each swift plugin a unique page. Can you confirm these setup instructions are accurate for your plugin?
For more context, this is in line with the setup instructions shown for all the other swift plugins:
rchinn1
added
the
content-update
rchinn1
approved these changes
Sep 19, 2023
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
1flow is launching a swift plugin, creating the page on their behalf
Merge timing
asap