You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+14-10
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Changelog
2
2
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.
4
4
5
5
**Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
6
6
@@ -15,6 +15,10 @@ All notable changes to this project will be documented in this file. Take a look
15
15
* It does not support HTTP streaming of ZIP packages.
16
16
* It offers better performance for LCP-protected publications containing large resources that are `deflated` instead of `stored` in the archive, which is not recommended.
17
17
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
+
18
22
### Deprecated
19
23
20
24
* 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
33
37
## [3.0.0-beta.2]
34
38
35
39
* 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.
37
41
38
42
### Added
39
43
@@ -129,7 +133,7 @@ All notable changes to this project will be documented in this file. Take a look
129
133
130
134
#### LCP
131
135
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.
133
137
134
138
### Fixed
135
139
@@ -152,7 +156,7 @@ All notable changes to this project will be documented in this file. Take a look
152
156
#### Shared
153
157
154
158
*`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.
156
160
* Links are not resolved to the `self` URL of a manifest anymore. However, you can still normalize the HREFs yourselves by calling `Manifest.normalizeHREFsToSelf()`.
157
161
*`Publication.localizedTitle` is now optional, as we cannot guarantee a publication will always have a title.
158
162
@@ -335,8 +339,8 @@ All notable changes to this project will be documented in this file. Take a look
335
339
336
340
* New `VisualNavigatorDelegate` APIs to handle keyboard events (contributed by [@lukeslu](https://github.com/readium/swift-toolkit/pull/267)).
337
341
* 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).
340
344
* New EPUB user preferences:
341
345
* `fontWeight` - Base text font weight.
342
346
* `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
363
367
364
368
#### Streamer
365
369
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.
367
371
368
372
#### Navigator
369
373
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).
371
375
372
376
### Changed
373
377
@@ -392,11 +396,11 @@ All notable changes to this project will be documented in this file. Take a look
392
396
#### Shared
393
397
394
398
* 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).
396
400
397
401
#### Navigator
398
402
399
-
*[A brand new text-to-speech implementation](Documentation/Guides/TTS.md).
403
+
*[A brand new text-to-speech implementation](docs/Guides/TTS.md).
0 commit comments