Skip to content

Commit

Permalink
Slightly reworked the presentation of the project
Browse files Browse the repository at this point in the history
  • Loading branch information
HadrienGardeur committed Apr 16, 2024
1 parent ae09d93 commit 5932939
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 19 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
47 changes: 29 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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).

0 comments on commit 5932939

Please sign in to comment.