BibleKit

BibleKit is a Swift package that provides Bible-related functionality for iOS and macOS platforms.

Features

• 🔍 Powerful verse search functionality
• 📚 Bible database access
• 📱 Support for iOS and macOS
• ⚡️ Built with Swift

Requirements

• iOS: 13.0+
• macOS: 10.15+

Installation

Swift Package Manager

Add BibleKit to your project using Swift Package Manager:

.package(url: "https://github.com/VerseWell/BibleKit-swift.git", from: "0.2.0")

Then add BibleKit as a dependency in your target:

.target(
    name: "YourApp",
    dependencies: [
        .product(name: "BibleKit", package: "BibleKit-swift")
    ]
)

Usage

Important

Your app must include a file named bible.db in its bundle. This SQLite database file contains the Bible content and is required for the library to function. You can find:

• Example database file: bible.db (World English Bible with translation modifications)
• Database schema: database.sq

You can replace the bible.db file with your preferred translation as long as it follows the same database schema.

Swift

import BibleKit

// Create a provider with your bible.db file
let provider = BibleProvider.create(
    url: Bundle.main.url(forResource: "bible", withExtension: "db")!
)

// Search for verses containing a word
Task {
    let results = try await provider.search(query: "love")
    for verse in results {
        print(verse.id.bookChapterVerse(), verse.text)
    }
}

Kotlin Multiplatform

For teams that need cross-platform support (Android, iOS, macOS), consider using BibleKit KMP, our Kotlin Multiplatform solution.

Documentation

For detailed API documentation, visit BibleKit Swift Documentation.

Bible Translation

The example database included with BibleKit uses the World English Bible translation (Protestant, US English) with modifications.

• You can visit the official WEB page for more information about this translation.
• For details regarding the modifications we've made to the WEB translation in our database, please refer to our Translation Modifications documentation.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.