Readium Mobile is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin.

Implemented Partially implemented Planned Want to do Not planned

A number of features are implemented only for some publication formats.

Guides are available to help you make the most of the toolkit.

• Opening a publication - parse a publication package (EPUB, PDF, etc.) or manifest (RWPM) into Readium Publication models
• Extracting the content of a publication - API to extract the text content of a publication for searching or indexing it
• Text-to-speech - read aloud the content of a textual publication using speech synthesis
• Accessibility - inspect accessibility metadata and present it to users

• Navigator - an overview of the Navigator to render a Publication's content to the user
• Configuring the Navigator - setup and render Navigator user preferences (font size, colors, etc.)
• Font families in the EPUB navigator - support custom font families with reflowable EPUB publications
• Integrating the Navigator with SwiftUI - glue to setup the Navigator in a SwiftUI application

• Supporting Readium LCP - open and render LCP DRM protected publications

The toolkit's libraries are distributed with Swift Package Manager (recommended), Carthage and CocoaPods. It's also possible to clone the repository (or a fork) and depend on the libraries locally.

The Test App contains examples on how to use all these dependency managers.

From Xcode, open File > Add Packages and use Readium's GitHub repository for the package URL: https://github.com/readium/swift-toolkit.git.

You are then free to add one or more Readium libraries to your application. They are designed to work independently.

If you're stuck, find more information at developer.apple.com.

Add the following to your Cartfile:

Then, follow the usual Carthage steps to add the Readium libraries to your project.

Note that Carthage will build all Readium modules and their dependencies, but you are free to add only the ones you are actually using. The Readium libraries are designed to work independently.

Refer to the following table to know which dependencies are required for each Readium library.

Add the following pod statements to your Podfile for the Readium libraries you want to use: