https://github.com/readium/architecture

📚 Documents the architecture of the Readium projects
https://github.com/readium/architecture

audiobook-player audiobooks ebook-reader ebooks epub readium webpub

Last synced: 3 months ago
JSON representation

📚 Documents the architecture of the Readium projects

• Host: GitHub
• URL: https://github.com/readium/architecture
• Owner: readium
• License: bsd-3-clause
• Created: 2016-09-07T17:59:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T06:46:06.000Z (9 months ago)
• Last Synced: 2024-10-06T11:04:30.553Z (7 months ago)
• Topics: audiobook-player, audiobooks, ebook-reader, ebooks, epub, readium, webpub
• Language: JavaScript
• Homepage: https://readium.org/architecture/
• Size: 4.94 MB
• Stars: 175
• Watchers: 76
• Forks: 33
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Readium Architecture

All Readium implementations (mobile, desktop or Web) are split in two main modules, which use the [Readium Web Publication Manifest](https://readium.org/webpub-manifest/) to communicate together.

On the Web, the [Publication Server](server) is responsible for serving a [Readium Web Publication Manifest](https://readium.org/webpub-manifest/) and the resources of a publication over HTTPS.

In native apps, the [Streamer](streamer) is responsible for parsing packaged publications and exposing them using an in-memory model.

On all platforms, the [Navigator](navigator) is meant to navigate in the resources of a publication and can adopt very different strategy based on the nature of the publication (ebooks, audiobooks and comics).

These modules are not necessarily meant to be deployed on the same device or written in the same language, which lets developers select the best implementation based on their requirements.

![Diagram of the Readium Architecture](other/images/architecture.svg)

 

## Projects

* [Readium Mobile](https://readium.org/mobile)

* [Readium CSS](https://readium.org/readium-css)

* [Readium Desktop](https://readium.org/desktop)

* [Readium Web](https://readium.org/web)

## Components

### Models

* [Readium Web Publication Manifest](https://readium.org/webpub-manifest)

* [Guided Navigation](https://readium.org/guided-navigation)

* [Locators](models/locators)

* [OPDS 2.0](https://drafts.opds.io/opds-2.0) (maintained by the OPDS Community)

### Services

* [Positions List](models/locators/positions)

## API

The API of each module is specified via [Readium Evolution Proposals](https://readium.org/architecture/proposals/), which are discussed collaborativelty before being implemented by the core developers of the toolkits. 

## Ecosystem

Take a look at our dedicated [awesome-readium repository](https://github.com/readium/awesome-readium) to explore the ecosystem built around Readium.