Skip to content

Installation

The SDK ships as a Swift package. The module and product name is AppGantrySDK.

Add the package

In Xcode use File > Add Package Dependencies… and enter the repository URL, or add it to your own Package.swift:

dependencies: [
    .package(url: "https://github.com/AppGantry/iOS-SDK.git", branch: "main"),
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [.product(name: "AppGantrySDK", package: "iOS-SDK")]
    ),
]

Then import it where you use it:

import AppGantrySDK

Requirements

  • iOS 16.0 or later (also supports macOS 13 or later).
  • Swift 5.9 or later.

Early-development caveat

Pin to a branch, not a tag

The SDK is in early development and has no tagged releases yet. The package resolves against the main branch, so you are tracking the head of main rather than a fixed version. The API is subject to change while it stabilises.

Pinning to branch: "main" means a package update can pull in breaking changes. If you need a stable point to build against, resolve the package once and commit your Package.resolved so upgrades are deliberate rather than automatic. Watch the releases page for the first tagged version.

Next