Update README (#578)

Author: mickael-menu

README.md

@@ -3,17 +3,83 @@
 [Readium Mobile](https://github.com/readium/mobile) is a toolkit for ebooks, audiobooks and comics written in Swift & Kotlin.
 
 > [!TIP]
-> **Take a look at the [guide to get started](docs/Guides/Getting%20Started.md).** A [Test App](TestApp) demonstrates how to integrate the Readium Swift toolkit in your own reading app.
+> **Take a look at the [guide to quickly get started](docs/Guides/Getting%20Started.md).** A [Test App](TestApp) demonstrates how to integrate the Readium Swift toolkit in your own reading app.
 
-This toolkit is a modular project, which follows the [Readium Architecture](https://github.com/readium/architecture).
+## Features
 
-* [`ReadiumShared`](Sources/Shared) – Shared `Publication` models and utilities
-* [`ReadiumStreamer`](Sources/Streamer) – Publication parsers and local HTTP server
-* [`ReadiumNavigator`](Sources/Navigator) – Plain `UIViewController` classes rendering publications
-* [`ReadiumOPDS`](Sources/OPDS) – Parsers for OPDS catalog feeds
-* [`ReadiumLCP`](Sources/LCP) – Service and models for [Readium LCP](https://www.edrlab.org/readium-lcp/)
+✅ Implemented      🚧 Partially implemented       📆 Planned      👀 Want to do      ❌ Will not do
 
-## Minimum Requirements
+### Formats
+
+| Format | Status |
+|---|:---:|
+| EPUB 2 | ✅ |
+| EPUB 3 | ✅ |
+| Readium Web Publication | 🚧 |
+| PDF | ✅ |
+| Readium Audiobook | ✅ |
+| Zipped Audiobook | ✅ |
+| Standalone audio files (MP3, AAC, etc.) | ✅ |
+| Readium Divina | 🚧 |
+| CBZ (Comic Book ZIP) | 🚧 |
+| CBR (Comic Book RAR) | ❌ |
+| [DAISY](https://daisy.org/activities/standards/daisy/) | 👀 |
+
+### Features
+
+A number of features are implemented only for some publication formats.
+
+| Feature | EPUB (reflow) | EPUB (FXL) | PDF |
+|---|:---:|:---:|:---:|
+| Pagination | ✅ | ✅ | ✅ |
+| Scrolling | ✅ | 👀 | ✅ |
+| Right-to-left (RTL) | ✅ | ✅ |  ✅ |
+| Search in textual content | ✅ | ✅ | 👀 | ❌ |
+| Highlighting (Decoration API) | ✅ | ✅ | 👀 |
+| Text-to-speech (TTS) | ✅ | ✅ | 👀 |
+| Media overlays | 📆 | 📆 | |
+
+### OPDS Support
+
+| Feature | Status |
+|---|:---:|
+| [OPDS Catalog 1.2](https://specs.opds.io/opds-1.2) | ✅ | 
+| [OPDS Catalog 2.0](https://drafts.opds.io/opds-2.0) | ✅ | 
+| [Authentication for OPDS](https://drafts.opds.io/authentication-for-opds-1.0.html) | 📆 |
+| [Readium LCP Automatic Key Retrieval](https://readium.org/lcp-specs/notes/lcp-key-retrieval.html) | 📆 |
+
+### DRM Support
+
+| Feature | Status |
+|---|:---:|
+| [Readium LCP](https://www.edrlab.org/projects/readium-lcp/) | ✅ |
+| [Adobe ACS](https://www.adobe.com/fr/solutions/ebook/content-server.html) | ❌ |
+
+
+## User Guides
+
+Guides are available to help you make the most of the toolkit.
+
+### Publication
+
+* [Opening a publication](docs/Guides/Open%20Publication.md) – parse a publication package (EPUB, PDF, etc.) or manifest (RWPM) into Readium `Publication` models
+* [Extracting the content of a publication](docs/Guides/Content.md) – API to extract the text content of a publication for searching or indexing it
+* [Text-to-speech](docs/Guides/TTS.md) – read aloud the content of a textual publication using speech synthesis
+
+### Navigator
+
+* [Navigator](docs/Guides/Navigator/Navigator.md) - an overview of the Navigator to render a `Publication`'s content to the user
+* [Configuring the Navigator](docs/Guides/Navigator/Preferences.md) – setup and render Navigator user preferences (font size, colors, etc.)
+* [Font families in the EPUB navigator](docs/Guides/Navigator/EPUB%20Fonts.md) – support custom font families with reflowable EPUB publications
+* [Integrating the Navigator with SwiftUI](docs/Guides/Navigator/SwiftUI.md) – glue to setup the Navigator in a SwiftUI application
+
+### DRM
+
+* [Supporting Readium LCP](docs/Guides/Readium%20LCP.md) – open and render LCP DRM protected publications
+
+## Setting up the Readium Swift toolkit
+
+### Minimum Requirements
 
 <!-- https://swiftversion.net/ -->
 
@@ -25,23 +91,22 @@ This toolkit is a modular project, which follows the [Readium Architecture](http
 | 2.5.0     | 10.0 | 5.6.1          | 13.4  |
 | 2.4.0     | 10.0 | 5.3.2          | 12.4  |
 
-## Using Readium
 
-<!--:question: **Find documentation and API reference at [readium.org/kotlin-toolkit](https://readium.org/swift-toolkit)**.-->
+### Dependencies
 
-Readium libraries are distributed with [Swift Package Manager](#swift-package-manager) (recommended), [Carthage](#carthage) and [CocoaPods](#cocoapods). It's also possible to clone the repository (or a fork) and [depend on the libraries locally](#local-git-clone).
+The toolkit's libraries are distributed with [Swift Package Manager](#swift-package-manager) (recommended), [Carthage](#carthage) and [CocoaPods](#cocoapods). It's also possible to clone the repository (or a fork) and [depend on the libraries locally](#local-git-clone).
 
 The [Test App](TestApp) contains examples on how to use all these dependency managers.
 
-### Swift Package Manager
+#### Swift Package Manager
 
 From Xcode, open **File** > **Add Packages** and use Readium's GitHub repository for the package URL: `https://github.com/readium/swift-toolkit.git`.
 
 You are then free to add one or more Readium libraries to your application. They are designed to work independently.
 
 If you're stuck, find more information at [developer.apple.com](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app).
 
-### Carthage
+#### Carthage
 
 Add the following to your `Cartfile`:
 
@@ -68,7 +133,7 @@ Refer to the following table to know which dependencies are required for each Re
 | `SQLite.swift`         |                    |                    |                    |                    |                    |                              | :heavy_check_mark:        |
 | `SwiftSoup`            | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                              |                           |
 
-### CocoaPods
+#### CocoaPods
 
 Add the following `pod` statements to your `Podfile` for the Readium libraries you want to use:
 
@@ -85,7 +150,7 @@ pod 'ReadiumLCP', '~> 3.2.0'
 
 Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.
 
-### Local Git Clone
+#### Local Git Clone
 
 You may prefer to use a local Git clone if you want to contribute to Readium, or if you are using your own fork.