architecture

Projects

iOS

For an overview of how Readium on iOS works, we highly recommend taking a look at the iOS Test App.

The Test App integrates the following modules (all written in Swift) into a single iOS application:

The iOS Test App can also be downloaded from the AppStore as R2 Reader.

While this project is dedicated to iOS for now, it is expected to support macOS as well in the future.

Android & Chrome OS

For an overview of how Readium on Android works, we highly recommend taking a look at the Android Test App.

The Test App integrates the following modules (all written in Kotlin) into a single Android application:

The Android Test App can also be downloaded from the Play Store as R2 Reader.

Web

Readium Web is in the process of being gradually moved to Readium repos.

Currently, the following repos are available on Github:

Unlike our other projects, Readium Web does not necessarily require running a streamer. Publications can be served unpackaged using static assets and the Readium Web Publication Manifest or through a streamer hosted on a server such as the Node.js or Go projects.

Desktop

Readium Desktop is built on top of Node.js and Electron.

For an overview of how Readium on Desktop works, we highly recommend taking a look at the Desktop Test App.

The Test App integrates the following modules (all written in TypeScript) into a single Electron application:

Go

The first implementation of a streamer was written in Go, mostly for server-side deployment.

It is primarily meant to be used as a back-end for Web apps built on top of Readium Web.

This project is active and hosted on this organization.

Prototypes

Contributing

If you’d like to contribute to these projects, make sure that you take a look at our dedicated page.