README.md

Readium Kotlin Toolkit

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

This toolkit is a modular project, which follows the Readium Architecture. The different modules are found under readium/.

• shared – Shared Publication models and utilities
• streamer – Publication parsers and local HTTP server
• navigator – Plain Fragment and Activity classes rendering publications
• opds – Parsers for OPDS catalog feeds
• lcp – Service and models for Readium LCP
• adapters – Adapters to use third-party libraries with Readium.
  • adapters/pdfium – Parse and render PDFs using the open source library PdfiumAndroid.
  • adapters/pspdfkit – Parse and render PDFs using the commercial library PSPDFKit.

A Test App demonstrates how to integrate the Readium Kotlin toolkit in your own reading app.

❓ Find documentation and API reference at readium.org/kotlin-toolkit.

Minimum Requirements

Readium	Android min SDK	Android compile SDK	Kotlin compiler	Gradle
latest	21	33	1.7.10	6.9.3

Setting Up Readium

Readium modules are distributed through JitPack. Make sure that you have the $readium_version property set in your root build.gradle, then add the JitPack and JCenter repositories.

buildscript {
    ext.readium_version = '2.3.0'
}

allprojects {
    repositories {
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

Then, add the dependencies to the Readium modules you need in your app's build.gradle.

dependencies {
    implementation "com.github.readium.kotlin-toolkit:readium-shared:$readium_version"
    implementation "com.github.readium.kotlin-toolkit:readium-streamer:$readium_version"
    implementation "com.github.readium.kotlin-toolkit:readium-navigator:$readium_version"
    implementation "com.github.readium.kotlin-toolkit:readium-opds:$readium_version"
    implementation "com.github.readium.kotlin-toolkit:readium-lcp:$readium_version"
}

Using a local Git clone

You may prefer to use a local Git clone if you want to contribute to Readium, or if you are using your own fork.

First, add the repository as a Git submodule of your app repository, then checkout the desired branch or tag:

git submodule add https://github.com/readium/kotlin-toolkit.git

Make sure you have Jetifier enabled in your gradle.properties file:

android.enableJetifier=true

Then, include the Readium build to your project's settings.gradle file. The Readium dependencies will automatically build against the local sources.

// Provide the path to the Git submodule.
includeBuild 'kotlin-toolkit'

⚠️ When importing Readium locally, you will need to use the same version of the Android Gradle Plugin in your project.

Building with Readium LCP

Using the toolkit with Readium LCP requires additional dependencies, including the binary liblcp provided by EDRLab. Contact EDRLab to request your private liblcp and the setup instructions.