Overview

Readium SDK consists of three major parts:

  • readium-sdk
  • readium-shared-js
  • SDKLauncher-*

The diagram below illustrates the high-level relationship of the parts of the architecture.

readium-sdk

readium-sdk

This is is the Core C++ code that manages the EPUB package, metadata, navigating and fetching resources and so on. The Core is platform-independent. In addition to the C++ core, there are also platform-dependent code layers that provide the interfaces to the platform-specific language layers:

  • iOS and OSX: There is no interface layer since Objective-C can call C++ directly. However, there is an interface layer (in Objective-C) called RDServices Android: This is the Java/C JNI layer.
  • Windows:
    • There is no functional Windows Launcher as interest in it was minimal.

readium-shared-js

This layer, as its name implies, is pure JavaScript. It provides the interfaces and services between the application layer (in Objective-C, C++, or Java) and the Core as well as the web-browser engine instance. This layer is shared across all platforms and sub-projects, including both ReadiumJS sub-projects and all SDK-based applications. It manages messaging between the native layers as well as providing the management of views and other facilities of the browser engine.

SDKLauncher-*

These are platform-specific applications that facilitate testing of the rest of the SDK as well as providing a rudimentary demonstration of how to integrate native applications with the SDK. They are deliberately rather limited and crude since it is not the intent of Readium to compete with its own members, many of whose value proposition is integrating the SDK into their sophisticated applications and workflows.

The platforms supported by Readium SDK (as of summer 2015) are

  • iOS 7 and above
  • Android 4.x and above
  • OSX 10.7 and above

Of course, developers are welcome to tackle porting to and integration with other platforms, but the above are the only platforms against which the Readium SDK is validated and for which Launchers exist.

Releases

View the release notes for Readium SDK and JS.