Skip to content

Commit 3b485b4

Browse files
committed
Update changelog
1 parent 9b18fdc commit 3b485b4

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

CHANGELOG.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file. Take a look at [the migration guide](Documentation/Migration%20Guide.md) to upgrade between two major versions.
3+
All notable changes to this project will be documented in this file. Take a look at [the migration guide](docs/Migration%20Guide.md) to upgrade between two major versions.
44

55
**Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
66

@@ -15,6 +15,10 @@ All notable changes to this project will be documented in this file. Take a look
1515
* It does not support HTTP streaming of ZIP packages.
1616
* It offers better performance for LCP-protected publications containing large resources that are `deflated` instead of `stored` in the archive, which is not recommended.
1717

18+
#### LCP
19+
20+
* Support for streaming an LCP-protected publication from its License Document (LCPL). [Take a look at the LCP guide for more information](docs/Guides/Readium%20LCP.md#streaming-an-lcp-protected-package).
21+
1822
### Deprecated
1923

2024
* The `close()` and `Closeable` APIs are now deprecated. Resources are automatically released upon `deinit`, which aligns better with Swift.
@@ -33,7 +37,7 @@ All notable changes to this project will be documented in this file. Take a look
3337
## [3.0.0-beta.2]
3438

3539
* The Readium Swift toolkit now requires a minimum of iOS 13.4.
36-
* All the libraries are now available on a dedicated [Readium CocoaPods Specs repository](https://github.com/readium/podspecs). Take a look at [the migration guide](Documentation/Migration%20Guide.md) to migrate.
40+
* All the libraries are now available on a dedicated [Readium CocoaPods Specs repository](https://github.com/readium/podspecs). Take a look at [the migration guide](docs/Migration%20Guide.md) to migrate.
3741

3842
### Added
3943

@@ -129,7 +133,7 @@ All notable changes to this project will be documented in this file. Take a look
129133

130134
#### LCP
131135

132-
* The Readium LCP persistence layer was extracted to allow applications to provide their own implementations. Take a look at [the migration guide](Documentation/Migration%20Guide.md) for guidance.
136+
* The Readium LCP persistence layer was extracted to allow applications to provide their own implementations. Take a look at [the migration guide](docs/Migration%20Guide.md) for guidance.
133137

134138
### Fixed
135139

@@ -152,7 +156,7 @@ All notable changes to this project will be documented in this file. Take a look
152156
#### Shared
153157

154158
* `Link` and `Locator`'s `href` are normalized as valid URLs to improve interoperability with the Readium Web toolkits.
155-
* **You MUST migrate your database if you were persisting HREFs and Locators**. Take a look at [the migration guide](Documentation/Migration%20Guide.md) for guidance.
159+
* **You MUST migrate your database if you were persisting HREFs and Locators**. Take a look at [the migration guide](docs/Migration%20Guide.md) for guidance.
156160
* Links are not resolved to the `self` URL of a manifest anymore. However, you can still normalize the HREFs yourselves by calling `Manifest.normalizeHREFsToSelf()`.
157161
* `Publication.localizedTitle` is now optional, as we cannot guarantee a publication will always have a title.
158162

@@ -335,8 +339,8 @@ All notable changes to this project will be documented in this file. Take a look
335339

336340
* New `VisualNavigatorDelegate` APIs to handle keyboard events (contributed by [@lukeslu](https://github.com/readium/swift-toolkit/pull/267)).
337341
* This can be used to turn pages with the arrow keys, for example.
338-
* [Support for custom fonts with the EPUB navigator](Documentation/Guides/EPUB%20Fonts.md).
339-
* A brand new user preferences API for configuring the EPUB and PDF Navigators. This new API is easier and safer to use. To learn how to integrate it in your app, [please refer to the user guide](Documentation/Guides/Navigator%20Preferences.md) and [migration guide](Documentation/Migration%20Guide.md).
342+
* [Support for custom fonts with the EPUB navigator](docs/Guides/EPUB%20Fonts.md).
343+
* A brand new user preferences API for configuring the EPUB and PDF Navigators. This new API is easier and safer to use. To learn how to integrate it in your app, [please refer to the user guide](docs/Guides/Navigator%20Preferences.md) and [migration guide](docs/Migration%20Guide.md).
340344
* New EPUB user preferences:
341345
* `fontWeight` - Base text font weight.
342346
* `textNormalization` - Normalize font style, weight and variants, which improves accessibility.
@@ -363,11 +367,11 @@ All notable changes to this project will be documented in this file. Take a look
363367

364368
#### Streamer
365369

366-
* `PublicationServer` is deprecated. See the [the migration guide](Documentation/Migration%20Guide.md#2.5.0) to migrate the HTTP server.
370+
* `PublicationServer` is deprecated. See the [the migration guide](docs/Migration%20Guide.md#2.5.0) to migrate the HTTP server.
367371

368372
#### Navigator
369373

370-
* The EPUB `UserSettings` component is deprecated and replaced by the new Preferences API. [Take a look at the user guide](Documentation/Guides/Navigator%20Preferences.md) and [migration guide](Documentation/Migration%20Guide.md).
374+
* The EPUB `UserSettings` component is deprecated and replaced by the new Preferences API. [Take a look at the user guide](docs/Guides/Navigator%20Preferences.md) and [migration guide](docs/Migration%20Guide.md).
371375

372376
### Changed
373377

@@ -392,11 +396,11 @@ All notable changes to this project will be documented in this file. Take a look
392396
#### Shared
393397

394398
* Support for the accessibility metadata in RWPM per [Schema.org Accessibility Properties for Discoverability Vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/).
395-
* [Extract the raw content (text, images, etc.) of a publication](Documentation/Guides/Content.md).
399+
* [Extract the raw content (text, images, etc.) of a publication](docs/Guides/Content.md).
396400

397401
#### Navigator
398402

399-
* [A brand new text-to-speech implementation](Documentation/Guides/TTS.md).
403+
* [A brand new text-to-speech implementation](docs/Guides/TTS.md).
400404

401405
#### Streamer
402406

0 commit comments

Comments
 (0)