From 59329394f68374d7af09534cef33070d30ff65ea Mon Sep 17 00:00:00 2001 From: Hadrien Gardeur Date: Tue, 16 Apr 2024 17:00:59 +0200 Subject: [PATCH] Slightly reworked the presentation of the project --- LICENSE | 2 +- README.md | 47 +++++++++++++++++++++++++++++------------------ 2 files changed, 30 insertions(+), 19 deletions(-) diff --git a/LICENSE b/LICENSE index 672ad17..adae3f1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2020, Readium +Copyright (c) 2020, Readium Foundation All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index ee4e064..01d1041 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ -# Readium Mobile +# 📱 Readium Mobile Readium Mobile is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin. +[With 60+ applications](https://github.com/readium/awesome-readium?tab=readme-ov-file#apps-based-on-readium-mobile), it's the most popular toolkit for building reading applications on smartphones and tablets. + +## Formats + +The following formats are supported with optional [Readium LCP support](https://www.edrlab.org/readium-lcp/) for protection: + +- EPUB 2.x and 3.x support +- EPUB Fixed Layout (FXL) support +- PDF support +- Audiobook support ([streamed](https://readium.org/webpub-manifest/profiles/audiobook) or [packaged](https://readium.org/lcp-specs/notes/lcp-for-audiobooks.html)) + ## Features -- [x] EPUB 2.x and 3.x support -- [x] Audiobook support -- [x] PDF support -- [x] Readium LCP support -- [x] CBZ support -- [x] Custom styles -- [x] Night & sepia modes -- [x] Pagination and scrolling -- [x] Table of contents -- [x] OPDS 1.x and 2.0 support -- [x] FXL support -- [x] RTL support -- [x] Search in EPUB -- [x] Highlights/annotations -- [x] Text-to-Speech (TTS) support -- [ ] EPUB 3 Media Overlays -- [ ] Divina support +- Support for user preferences +- Night & sepia modes +- Search in EPUB +- Highlights/annotations +- Text-to-Speech (TTS) support +- Pagination and scrolling +- Support for right-to-left (RTL) and vertical scrolling + + +## Roadmap + +- [EPUB 3 Media Overlays](https://www.w3.org/TR/epub/#sec-media-overlays) +- [Divina support](https://readium.org/webpub-manifest/profiles/divina) for comics/manga/webtoons ## Codebase @@ -41,3 +48,7 @@ The toolkit currently requires iOS 11+. * [`swift-toolkit`](https://github.com/readium/swift-toolkit) – Monorepo for Readium Mobile in Swift. A [Test App](https://github.com/readium/swift-toolkit/tree/develop/TestApp) demonstrates how to integrate the Swift toolkit in your own reading app. + +## License + +Readium Mobile is available under a [BSD-3 license](https://github.com/readium/mobile/blob/main/LICENSE).