From 9faad757866051879f5692987c96034e1c4ccd41 Mon Sep 17 00:00:00 2001 From: DreamPiggy Date: Fri, 7 Feb 2020 17:57:35 +0800 Subject: [PATCH] Update the SwiftPM part about how to use pre-release version and complete more details documentation --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index fcb8352..a3e48c1 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,18 @@ github "SDWebImage/SDWebImageSwiftUI" SDWebImageSwiftUI is available through [Swift Package Manager](https://swift.org/package-manager/). ++ For App integration + +For App integration, you should using Xcode 11 or higher, to add this package to your App target. To do this, check [Adding Package Dependencies to Your App](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app?language=objc) about the step by step tutorial using Xcode. + +Note for any pre-release version like 1.0.0 beta, you should use the `Exact` dependency, or the `Range` dependency. Using `Up to next Major` does not resolve the pre-release version. + +![](https://user-images.githubusercontent.com/6919743/73805686-5451c180-4802-11ea-9b72-d082ad315bfc.png) + ++ For downstream framework + +For downstream framework author, you should create a `Package.swift` file into your git repo, then add the following line to mark your framework dependent our SDWebImageSwiftUI. + ```swift let package = Package( dependencies: [ @@ -82,6 +94,16 @@ let package = Package( ) ``` +Note for any pre-release version like 1.0.0 beta, you should use the SwiftPM [prereleaseIdentifiers](https://developer.apple.com/documentation/swift_packages/version/2878264-prereleaseidentifiers) API to specify it. The default `from:` does not resolve the pre-release version. + +```swift +let package = Package( + dependencies: [ + .package(url: "https://github.com/SDWebImage/SDWebImageSwiftUI.git", from: Version(1, 0, 0, prereleaseIdentifiers: ["-beta"]))) + ], +) +``` + ## Usage ### Using `WebImage` to load network image