Skip to content

Commit 9559039

Browse files
committed
Update documentation
1 parent dfbf3e0 commit 9559039

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

Documentation/Migration Guide.md

+11
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
44

5+
## 2.6.0
6+
7+
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:
8+
9+
* Swift Package Manager: There's nothing to do.
10+
* Carthage:
11+
* Update the Carthage dependencies and make sure the new `ReadiumGCDWebServer.xcframework` was built.
12+
* Replace `GCDWebServer.xcframework` with `ReadiumGCDWebServer.xcframework` in your project.
13+
* CocoaPods:
14+
* Rename the `pod 'GCDWebServer'` statement in your `Podfile` with `pod 'ReadiumGCDWebServer'`, then run `pod install`.
15+
516
## 2.5.0
617

718
In the following migration steps, only the `ReadiumInternal` one is mandatory with 2.5.0.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ Refer to the following table to know which dependencies are required for each Re
6060
| `CryptoSwift` | | :heavy_check_mark: | | | :heavy_check_mark: |
6161
| `DifferenceKit` | | | :heavy_check_mark: | | |
6262
| `Fuzi` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
63-
| `GCDWebServer` | | :heavy_check_mark: | | | |
6463
| `Minizip` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
64+
| `ReadiumGCDWebServer` | | :heavy_check_mark: | | | |
6565
| `SQLite.swift` | | | | | :heavy_check_mark: |
6666
| `SwiftSoup` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
6767
| `ZIPFoundation` | | | | | :heavy_check_mark: |
@@ -79,7 +79,7 @@ pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-tool
7979
pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.1/Support/CocoaPods/ReadiumInternal.podspec'
8080
8181
# Required if you use R2Streamer.
82-
pod 'GCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3.7.4/GCDWebServer.podspec'
82+
pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3.7.4/GCDWebServer.podspec'
8383
```
8484

8585
Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.

0 commit comments

Comments
 (0)