Install the SDK
Last updated
Last updated
Open the project you wish to install the framework into.
Select the project in the Project Navigator (A). Select your app's main target inside the TARGETS section (B), then click on the General tab (C) to open the general build settings for this target.
Verify that the version in Minimum Deployments is 15.0 or higher. If the version is lower than 15.0, update the minimum deployment to 15.0 or higher. If you wish to continue supporting users on devices running iOS lower than 15.0, contact us at flightrecorder@pulselabs.ai. NB: 14.x is now end of life, and users of these devices will no longer receive security updates from Apple.
In the menu bar, select File -> Add Package Dependencies....
In the Apple Swift Packages pop-up window, input https://github.com/pulselabs-ai/flight-recorder-swift-package into the Search or Enter Package URL search box in the top right corner.
Select an appropriate Dependency Rule. We follow Semantic Versioning 2.0.0, which means we will add bugfixes to the patch version (x.x.x), new features with no breaking changes to the minor version (x.x.x) and will always increase the major version (x.x.x) for breaking changes. We therefore recommend choosing Up to Next Major Version, to ensure you get all the patches and backwards compatible feature updates.
Select Add Package to install the package.
In the Choose Package Products for flight-recorder-swift-package.git window, select Add Package.
The SDK is now installed. It appears in the Package Dependencies list in the Project Navigator.
You can update the SDK at any time by right-clicking the package and selecting Update Package, or update it along with all your other packages in the menu bar by selecting File -> Packages -> Update to Latest Package Versions.
Remove the SDK by selecting your project in the Project Navigator, selecting the Package Dependencies tab, clicking on the package and clicking the - button.
Read on to learn how to Configure the SDK for your iOS app.
