2.7.0 (#410)

Author: mickael-menu

CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [2.7.0]
 
 ### Added
 
@@ -661,3 +663,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [2.5.1]: https://github.com/readium/swift-toolkit/compare/2.5.0...2.5.1
 [2.6.0]: https://github.com/readium/swift-toolkit/compare/2.5.1...2.6.0
 [2.6.1]: https://github.com/readium/swift-toolkit/compare/2.6.0...2.6.1
+[2.7.0]: https://github.com/readium/swift-toolkit/compare/2.6.1...2.7.0

Documentation/Migration Guide.md

@@ -2,7 +2,15 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
 
-## 2.6.0
+## 2.7.0
+
+### `AudioNavigator` is now stable
+
+`AudioNavigator` is now stable. Follow the deprecation errors to automatically rename the types.
+
+All the setting properties (e.g. `navigator.rate`) are now in `navigator.settings`.
+
+### GCDWebServer was renamed
 
 To avoid [name collision with GCDWebServer](https://github.com/readium/swift-toolkit/issues/402), we renamed [our fork](https://github.com/readium/gcdwebserver) to `ReadiumGCDWebServer`. You will need to update your project to replace the old dependency:
 
@@ -11,7 +19,11 @@ To avoid [name collision with GCDWebServer](https://github.com/readium/swift-too
     * Update the Carthage dependencies and make sure the new `ReadiumGCDWebServer.xcframework` was built.
     * Replace `GCDWebServer.xcframework` with `ReadiumGCDWebServer.xcframework` in your project.
 * CocoaPods:
-    * Rename the `pod 'GCDWebServer'` statement in your `Podfile` with `pod 'ReadiumGCDWebServer'`, then run `pod install`.
+    * Replace the `pod 'GCDWebServer'` statement in your `Podfile` with the following, before running `pod install`.
+        ```
+        pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/4.0.0/GCDWebServer.podspec'
+        ```
+
 
 ## 2.5.0
 

README.md

@@ -44,7 +44,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
 Add the following to your `Cartfile`:
 
 ```
-github "readium/swift-toolkit" ~> 2.6.1
+github "readium/swift-toolkit" ~> 2.7.0
 ```
 
 Then, [follow the usual Carthage steps](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to add the Readium libraries to your project.
@@ -71,15 +71,15 @@ Refer to the following table to know which dependencies are required for each Re
 Add the following `pod` statements to your `Podfile` for the Readium libraries you want to use:
 
 ```
-pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumShared.podspec'
-pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumStreamer.podspec'
-pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumNavigator.podspec'
-pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumOPDS.podspec'
-pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumLCP.podspec'
-pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumInternal.podspec'
+pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumShared.podspec'
+pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumStreamer.podspec'
+pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumNavigator.podspec'
+pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumOPDS.podspec'
+pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumLCP.podspec'
+pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumInternal.podspec'
 
 # Required if you use R2Streamer.
-pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3.7.4/GCDWebServer.podspec'
+pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/4.0.0/GCDWebServer.podspec'
 ```
 
 Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.

Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumAdapterGCDWebServer"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Adapter to use GCDWebServer as an HTTP server in Readium"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.source_files  = "Sources/Adapters/GCDWebServer/**/*.{m,h,swift}"
   s.platform      = :ios

Support/CocoaPods/ReadiumInternal.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumInternal"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Private utilities used by the Readium modules"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.source_files  = "Sources/Internal/**/*.{m,h,swift}"
   s.platform      = :ios

Support/CocoaPods/ReadiumLCP.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumLCP"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium LCP"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.resource_bundles = {
     'ReadiumLCP' => [

Support/CocoaPods/ReadiumNavigator.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "R2Navigator"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "R2 Navigator"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.resource_bundles = {
     'ReadiumNavigator' => [

Support/CocoaPods/ReadiumOPDS.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumOPDS"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium OPDS"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.resource_bundles = {
     'ReadiumOPDS' => ['Sources/OPDS/Resources/**'],

Support/CocoaPods/ReadiumShared.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name         = "R2Shared"
-  s.version      = "2.6.1"
+  s.version      = "2.7.0"
   s.license      = "BSD 3-Clause License"
   s.summary      = "R2 Shared"
   s.homepage     = "http://readium.github.io"
   s.author       = { "Readium" => "[email protected]" }
-  s.source       = { :git => 'https://github.com/readium/swift-toolkit.git', :branch => "develop" }
+  s.source       = { :git => 'https://github.com/readium/swift-toolkit.git', :tag => "2.7.0" }
   s.exclude_files = ["Sources/Shared/Toolkit/Archive/ZIPFoundation.swift"]
   s.requires_arc = true
   s.resource_bundles = {

Support/CocoaPods/ReadiumStreamer.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 
   s.name          = "R2Streamer"
-  s.version       = "2.6.1"
+  s.version       = "2.7.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "R2 Streamer"
   s.homepage      = "http://readium.github.io"
   s.author        = { "Readium" => "[email protected]" }
-  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
+  s.source        = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.7.0" }
   s.requires_arc  = true
   s.resource_bundles = {
     'ReadiumStreamer' => [