Quick Start

Get your App Key

Register your app at platform.youversion.com to get a free App Key.

Install the SDK

In Xcode, open File → Add Package Dependencies…, enter:

Swift Package URL
https://github.com/youversion/platform-sdk-swift.git

Select Up to Next Major Version, then add the YouVersionPlatform package product to your app target.

Configure the SDK

Call YouVersionPlatformConfiguration.configure once during application startup. Your @main App initializer is a convenient place to do this.

SampleApp.swift
import SwiftUI
import YouVersionPlatform

@main
struct SampleApp: App {
    init() {
        YouVersionPlatformConfiguration.configure(
            appKey: "YOUR_APP_KEY_HERE"
        )
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

For built-in reader sign-in, you can also provide appName, isSignInEnabled, and signInPromptMessage. See Components for details.

Display a Bible passage

BibleCardView fetches a passage and renders its reference, text, version, and attribution.

ContentView.swift
import SwiftUI
import YouVersionPlatform

struct ContentView: View {
    var body: some View {
        BibleCardView(
            reference: BibleReference(
                versionId: 3034,
                bookUSFM: "JHN",
                chapter: 3,
                verse: 16
            )
        )
    }
}