Skip to content

About

Squiddy SDK

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Squiddy SDK for iOS

The Swift package of the Squiddy SDK, version 0.2.0. An iOS app reads its remote configuration from Squiddy (settings, the update-required and maintenance gate, localized strings), keeps the last valid one for offline starts, and follows its changes. iOS 15 or later, Swift 5.9 or later.

Installation

In Xcode: File › Add Package Dependencies…, enter https://github.com/squiddy-cloud/squiddy-swift, and add the library Squiddy to the app's target. In a Package.swift:

dependencies: [
    .package(url: "https://github.com/squiddy-cloud/squiddy-swift", from: "0.2.0"),
],
targets: [
    .target(name: "MyApp", dependencies: [.product(name: "Squiddy", package: "squiddy-swift")]),
]

Usage

import Squiddy

let squiddy = try Squiddy.initialize(SquiddyOptions(
    host: "https://squiddy.example.com", apiKey: "sqk_…", appId: "my-app",
    appVersion: "2026.11.17", appMode: "release"))

let observation = squiddy.gate.observe { gate in
    switch gate {
    case let maintenance as AppGate.Maintenance: showMaintenance(maintenance.title, maintenance.message)
    case let update as AppGate.UpdateRequired: showUpdate(update.title, update.message)
    default: showApp()
    }
}

let title = squiddy.string(key: "welcome_title", fallback: "Welcome")

config, gate and strings give the value now, a callback on the main thread (observe) or an AsyncStream (values). Every type and member carries its documentation, which Xcode shows.

What the package holds

  • Sources/Squiddy: the Swift layer, plain Swift with no dependency beyond Foundation and Combine.
  • SquiddyCore.xcframework: the SDK's Kotlin code, compiled as a dynamic framework with a slice for devices (arm64) and one for the simulators of Apple silicon and Intel Macs, with its debug symbols. It is the asset of this version's release, and Package.swift names it by URL and by checksum.

The same SDK, at the same version, is on Maven Central for Android and the JVM: cloud.squiddy:squiddy:0.2.0. CHANGELOG.md lists the changes of every version.

The release pipeline of the SDK writes this repository at every release, from the SDK's own repository: a change made here is replaced by the next release.

License

Apache License 2.0.

About

Squiddy SDK

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages