Skip to content

Installation

ChiefVenzox edited this page Jun 5, 2026 · 1 revision

Installation

SwiftState is distributed as a Swift Package.

Xcode

  1. Open your app in Xcode.
  2. Select File > Add Package Dependencies....
  3. Paste the package URL:
https://github.com/ChiefVenzox/SwiftState.git
  1. Choose Branch and enter:
main
  1. Add the SwiftState product to your app target.

The main branch currently contains the newest APIs, including async effects and SwiftUI binding helpers. When a newer release tag is published, you can switch to a version rule such as Up to Next Major Version.

Package.swift

dependencies: [
    .package(url: "https://github.com/ChiefVenzox/SwiftState.git", branch: "main")
]

Then add SwiftState to your target dependencies:

.target(
    name: "YourApp",
    dependencies: ["SwiftState"]
)

Requirements

  • Swift 5.7 or newer
  • Xcode 14 or newer
  • iOS 15+
  • macOS 12+
  • tvOS 15+
  • watchOS 8+

Verify Installation

After adding the package, import it in a Swift file:

import SwiftState

If the project builds, SwiftState is ready to use.

Clone this wiki locally