Skip to content

Commit c6b8e8e

Browse files
authored
Update README (#646)
1 parent 5af7078 commit c6b8e8e

File tree

2 files changed

+79
-17
lines changed

2 files changed

+79
-17
lines changed

README.md

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,86 @@
22

33
[Readium Mobile](https://github.com/readium/mobile) is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin.
44

5-
:point_up: **Take a look at the [guide to get started](docs/guides/getting-started.md).** A [Test App](test-app) demonstrates how to integrate the Readium Kotlin toolkit in your own reading app.
5+
:point_up: **Take a look at the [guide to quickly get started](docs/guides/getting-started.md).** A [Test App](test-app) demonstrates how to integrate the Readium Kotlin toolkit in your own reading app.
66

77
:question: **Find documentation and API reference at [readium.org/kotlin-toolkit](https://readium.org/kotlin-toolkit)**.
88

9-
## Minimum Requirements
9+
## Features
10+
11+
✅ Implemented      🚧 Partially implemented      📆 Planned      👀 Want to do      ❓ Not planned
12+
13+
### Formats
14+
15+
| Format | Status |
16+
|---|:---:|
17+
| EPUB 2 ||
18+
| EPUB 3 ||
19+
| Readium Web Publication | 🚧 |
20+
| PDF ||
21+
| Readium Audiobook ||
22+
| Zipped Audiobook ||
23+
| Standalone audio files (MP3, AAC, etc.) ||
24+
| Readium Divina | 🚧 |
25+
| CBZ (Comic Book ZIP) | 🚧 |
26+
| CBR (Comic Book RAR) ||
27+
| [DAISY](https://daisy.org/activities/standards/daisy/) | 👀 |
28+
29+
### Features
30+
31+
A number of features are implemented only for some publication formats.
32+
33+
| Feature | EPUB (reflow) | EPUB (FXL) | PDF |
34+
|---|:---:|:---:|:---:|
35+
| Pagination ||||
36+
| Scrolling || 👀 ||
37+
| Right-to-left (RTL) ||||
38+
| Search in textual content ||| 👀 |
39+
| Highlighting (Decoration API) ||| 👀 |
40+
| Text-to-speech (TTS) ||| 👀 |
41+
| Media overlays | 📆 | 📆 | |
42+
43+
### OPDS Support
44+
45+
| Feature | Status |
46+
|---|:---:|
47+
| [OPDS Catalog 1.2](https://specs.opds.io/opds-1.2) ||
48+
| [OPDS Catalog 2.0](https://drafts.opds.io/opds-2.0) ||
49+
| [Authentication for OPDS](https://drafts.opds.io/authentication-for-opds-1.0.html) | 📆 |
50+
| [Readium LCP Automatic Key Retrieval](https://readium.org/lcp-specs/notes/lcp-key-retrieval.html) | 📆 |
51+
52+
### DRM Support
53+
54+
| Feature | Status |
55+
|---|:---:|
56+
| [Readium LCP](https://www.edrlab.org/projects/readium-lcp/) ||
57+
| [Adobe ACS](https://www.adobe.com/fr/solutions/ebook/content-server.html) ||
58+
59+
## User Guides
60+
61+
Guides are available to help you make the most of the toolkit.
62+
63+
### Publication
64+
65+
* [Opening a publication](docs/guides/open-publication.md) – parse a publication package (EPUB, PDF, etc.) or manifest (RWPM) into Readium `Publication` models
66+
* [Extracting the content of a publication](docs/guides/content.md) – API to extract the text content of a publication for searching or indexing it
67+
* [Supporting PDF documents](docs/guides/pdf.md) – setup the PDF support in the toolkit
68+
* [Text-to-speech](docs/guides/tts.md) – read aloud the content of a textual publication using speech synthesis
69+
* [Accessibility](docs/guides/accessibility.md) – inspect and present accessibility metadata to users
70+
71+
### Navigator
72+
73+
* [Navigator](docs/guides/navigator/navigator.md) - an overview of the Navigator to render a `Publication`'s content to the user
74+
* [Configuring the Navigator](docs/guides/navigator/preferences.md) – setup and render Navigator user preferences (font size, colors, etc.)
75+
* [Font families in the EPUB navigator](docs/guides/navigator/epub-fonts.md) – support custom font families with reflowable EPUB publications
76+
* [Media Navigator](docs/guides/navigator/media-navigator.md) – use the Media Navigator to read aloud a publication (audiobook, TTS, etc.)
77+
78+
### DRM
79+
80+
* [Supporting Readium LCP](docs/guides/lcp.md) – open and render LCP DRM protected publications
81+
82+
## Setting up the Readium Kotlin toolkit
83+
84+
### Minimum Requirements
1085

1186
| Readium | Android min SDK | Android compile SDK | Kotlin compiler (✻) | Gradle (✻) |
1287
|-----------|-----------------|---------------------|---------------------|------------|
@@ -16,7 +91,7 @@
1691

1792
✻ Only required if you integrate Readium as a submodule instead of using Maven Central.
1893

19-
## Setting Up Readium
94+
### Dependencies
2095

2196
Readium modules are distributed with [Maven Central](https://search.maven.org/search?q=g:org.readium.kotlin-toolkit). Make sure that you have the `$readium_version` property set in your root `build.gradle`, then add the Maven Central repository.
2297

@@ -46,7 +121,7 @@ dependencies {
46121

47122
:warning: If you target Android devices running below API 26, you must enable [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) in your application module.
48123

49-
### Using a local Git clone
124+
#### Using a local Git clone
50125

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

docs/guides/README.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)