Skip to content

Commit

Permalink
2.5.0 (#285)
Browse files Browse the repository at this point in the history
  • Loading branch information
mickael-menu committed Apr 14, 2023
1 parent 4f38347 commit 9e03397
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 32 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.0]

### Added

Expand Down Expand Up @@ -530,3 +532,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
[unreleased]: https://github.com/readium/swift-toolkit/compare/main...HEAD
[2.3.0]: https://github.com/readium/swift-toolkit/compare/2.2.0...2.3.0
[2.4.0]: https://github.com/readium/swift-toolkit/compare/2.3.0...2.4.0
[2.5.0]: https://github.com/readium/swift-toolkit/compare/2.4.0...2.5.0
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,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.4.0
github "readium/swift-toolkit" ~> 2.5.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.
Expand All @@ -51,28 +51,30 @@ Note that Carthage will build all Readium modules and their dependencies, but yo

Refer to the following table to know which dependencies are required for each Readium library.

| | `R2Shared` | `R2Streamer` | `R2Navigator` | `ReadiumOPDS` | `ReadiumLCP` |
|-----------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
| **`R2Shared`** | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `CryptoSwift` | | :heavy_check_mark: | | | :heavy_check_mark: |
| `DifferenceKit` | | | :heavy_check_mark: | | |
| `Fuzi` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `GCDWebServer` | | :heavy_check_mark: | | | |
| `Minizip` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `SQLite.swift` | | | | | :heavy_check_mark: |
| `SwiftSoup` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ZIPFoundation` | | | | | :heavy_check_mark: |
| | `R2Shared` | `R2Streamer` | `R2Navigator` | `ReadiumOPDS` | `ReadiumLCP` |
|-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
| **`R2Shared`** | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| **`ReadiumInternal`** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `CryptoSwift` | | :heavy_check_mark: | | | :heavy_check_mark: |
| `DifferenceKit` | | | :heavy_check_mark: | | |
| `Fuzi` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `GCDWebServer` | | :heavy_check_mark: | | | |
| `Minizip` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `SQLite.swift` | | | | | :heavy_check_mark: |
| `SwiftSoup` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `ZIPFoundation` | | | | | :heavy_check_mark: |

### CocoaPods

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.4.0/Support/CocoaPods/ReadiumShared.podspec'
pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumStreamer.podspec'
pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumNavigator.podspec'
pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumOPDS.podspec'
pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumLCP.podspec'
pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumShared.podspec'
pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumStreamer.podspec'
pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumNavigator.podspec'
pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumOPDS.podspec'
pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumLCP.podspec'
pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.5.0/Support/CocoaPods/ReadiumInternal.podspec'
# Required if you use R2Streamer.
pod 'GCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3.7.3/GCDWebServer.podspec'
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumAdapterGCDWebServer"
s.version = "2.4.0"
s.version = "2.5.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" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.source_files = "Sources/Adapters/GCDWebServer/**/*.{m,h,swift}"
s.platform = :ios
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumInternal.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumInternal"
s.version = "2.4.0"
s.version = "2.5.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" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.source_files = "Sources/Internal/**/*.{m,h,swift}"
s.platform = :ios
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumLCP.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumLCP"
s.version = "2.4.0"
s.version = "2.5.0"
s.license = "BSD 3-Clause License"
s.summary = "Readium LCP"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.resource_bundles = {
'ReadiumLCP' => [
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumNavigator.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "R2Navigator"
s.version = "2.4.0"
s.version = "2.5.0"
s.license = "BSD 3-Clause License"
s.summary = "R2 Navigator"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.resource_bundles = {
'ReadiumNavigator' => [
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumOPDS.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumOPDS"
s.version = "2.4.0"
s.version = "2.5.0"
s.license = "BSD 3-Clause License"
s.summary = "Readium OPDS"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.resource_bundles = {
'ReadiumOPDS' => ['Sources/OPDS/Resources/**'],
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumShared.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = 'R2Shared'
s.version = '2.4.0'
s.version = '2.5.0'
s.license = 'BSD 3-Clause License'
s.summary = 'R2 Shared'
s.homepage = 'http://readium.github.io'
s.author = { "Readium" => "contact@readium.org" }
s.source = { :git => 'https://github.com/readium/swift-toolkit.git', :branch => "develop" }
s.source = { :git => 'https://github.com/readium/swift-toolkit.git', :tag => "2.5.0" }
s.exclude_files = ["Sources/Shared/Toolkit/Archive/ZIPFoundation.swift"]
s.requires_arc = true
s.resource_bundles = {
Expand Down
4 changes: 2 additions & 2 deletions Support/CocoaPods/ReadiumStreamer.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "R2Streamer"
s.version = "2.4.0"
s.version = "2.5.0"
s.license = "BSD 3-Clause License"
s.summary = "R2 Streamer"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "contact@readium.org" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => "2.5.0" }
s.requires_arc = true
s.resource_bundles = {
'ReadiumStreamer' => [
Expand Down

0 comments on commit 9e03397

Please sign in to comment.