├── .gitignore
├── LICENSE
├── README.md
└── _layouts
    └── default.html


/.gitignore:
--------------------------------------------------------------------------------
1 | 
2 | .DS_Store
3 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | BSD 3-Clause License
 2 | 
 3 | Copyright (c) 2020, Readium Foundation
 4 | All rights reserved.
 5 | 
 6 | Redistribution and use in source and binary forms, with or without
 7 | modification, are permitted provided that the following conditions are met:
 8 | 
 9 | 1. Redistributions of source code must retain the above copyright notice, this
10 |    list of conditions and the following disclaimer.
11 | 
12 | 2. Redistributions in binary form must reproduce the above copyright notice,
13 |    this list of conditions and the following disclaimer in the documentation
14 |    and/or other materials provided with the distribution.
15 | 
16 | 3. Neither the name of the copyright holder nor the names of its
17 |    contributors may be used to endorse or promote products derived from
18 |    this software without specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # 📱 Readium Mobile
 2 | 
 3 | Readium Mobile is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin.
 4 | 
 5 | [With 100+ 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.
 6 | 
 7 | ## Formats
 8 | 
 9 | The following formats are supported with optional [Readium LCP support](https://www.edrlab.org/readium-lcp/) for protection:
10 | 
11 | - EPUB 2.x and 3.x support
12 | - EPUB Fixed Layout (FXL) support
13 | - PDF support
14 | - Audiobook support ([streamed](https://readium.org/webpub-manifest/profiles/audiobook) or [packaged](https://readium.org/lcp-specs/notes/lcp-for-audiobooks.html))
15 | 
16 | ## Features
17 | 
18 | - Support for user preferences
19 | - Night & sepia modes
20 | - Search in EPUB
21 | - Highlights/annotations
22 | - Text-to-Speech (TTS) support
23 | - Pagination and scrolling
24 | - Support for right-to-left (RTL) and vertical scrolling
25 | 
26 | 
27 | ## Roadmap
28 | 
29 | - [EPUB 3 Media Overlays](https://www.w3.org/TR/epub/#sec-media-overlays)
30 | - [Divina support](https://readium.org/webpub-manifest/profiles/divina) for comics/manga/webtoons
31 | 
32 | ## Android and Chrome OS
33 | 
34 | The toolkit currently requires Android 5.0+.
35 | 
36 | * [`kotlin-toolkit`](https://github.com/readium/kotlin-toolkit) – Monorepo for Readium Mobile in Kotlin.
37 | 
38 | A [Test App](https://github.com/readium/kotlin-toolkit/tree/develop/test-app) demonstrates how to integrate the Kotlin toolkit in your own reading app.
39 | 
40 | ## iOS, iPadOS and macOS
41 | 
42 | The toolkit currently requires iOS 11+. On macOS, it's compatible with devices using Apple silicon (M1 or above).
43 | 
44 | * [`swift-toolkit`](https://github.com/readium/swift-toolkit) – Monorepo for Readium Mobile in Swift.
45 | 
46 | A [Test App](https://github.com/readium/swift-toolkit/tree/develop/TestApp) demonstrates how to integrate the Swift toolkit in your own reading app.
47 | 
48 | ## License
49 | 
50 | Readium Mobile is available under a [BSD-3 license](https://github.com/readium/mobile/blob/main/LICENSE).
51 | 
52 | ```
53 | BSD 3-Clause License
54 | 
55 | Copyright (c) 2017, Readium Foundation
56 | All rights reserved.
57 | 
58 | Redistribution and use in source and binary forms, with or without
59 | modification, are permitted provided that the following conditions are met:
60 | 
61 | 1. Redistributions of source code must retain the above copyright notice, this
62 |    list of conditions and the following disclaimer.
63 | 
64 | 2. Redistributions in binary form must reproduce the above copyright notice,
65 |    this list of conditions and the following disclaimer in the documentation
66 |    and/or other materials provided with the distribution.
67 | 
68 | 3. Neither the name of the copyright holder nor the names of its
69 |    contributors may be used to endorse or promote products derived from
70 |    this software without specific prior written permission.
71 | 
72 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
73 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
74 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
75 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
76 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
77 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
78 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
79 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
80 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
81 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
82 | ```
83 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="{{ site.lang | default: "en-US" }}">
 3 |   <head>
 4 |     <meta charset="UTF-8">
 5 |     <meta http-equiv="X-UA-Compatible" content="IE=edge">
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 7 | 
 8 | {% seo %}
 9 |     <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
10 |     <style>
11 |       .rfc {
12 |           color: #d55;
13 |           font-variant: small-caps;
14 |           font-style: normal;
15 |           font-weight: normal;
16 |       }
17 |     </style>
18 |   </head>
19 |   <body>
20 |     <div class="container-lg px-3 my-5 markdown-body">
21 | 
22 |       <a href="https://readium.org">
23 |         <img src="https://readium.org/assets/logos/readium-logo.png" height="100" alt="Readium Logo">
24 |       </a>
25 | 
26 |       {{ content }}
27 | 
28 |     </div>
29 |     <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
30 |     <script>anchors.add();</script>
31 |   </body>
32 | </html>


--------------------------------------------------------------------------------