Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit 14456d6

Browse files
committed
Updated README
1 parent 12ae1f8 commit 14456d6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,13 @@ If the target you are creating an XCFramework happens to be a dependency, swift-
8787

8888
If the target you are creating is a product from the root package, unfortunately there is no standard way to identify the version number. For those cases you can specify one with `--zip-version`.
8989

90+
Because you're probably wanting to [distribute your binary frameworks as Swift Packages][apple-docs] `swift create-xcframework --zip` will also calculate the necessary SHA256 checksum and place it alongside the zip. eg: `ArgumentParser-0.0.6.sha256`.
91+
9092
## GitHub Action
9193

9294
swift-create-xcframework includes a GitHub Action that can kick off and automatically create an XCFramework when you tag a release in your project.
9395

94-
The action produces one XCFramework artifact for every target specified.
96+
The action produces one zipped XCFramework and checksum artifact for every target specified.
9597

9698
**Note:** You MUST use a macOS-based runner (such as `macos-latest`) as xcodebuild doesn't run on Linux.
9799

@@ -152,4 +154,6 @@ Please read the [Contribution Guide](CONTRIBUTING.md) for details on how to cont
152154

153155
## License
154156

155-
swift-create-xcframework is available under the MIT license. See the [LICENSE](LICENSE) file for more info.
157+
swift-create-xcframework is available under the MIT license. See the [LICENSE](LICENSE) file for more info.
158+
159+
[apple-docs]: https://developer.apple.com/documentation/swift_packages/distributing_binary_frameworks_as_swift_packages

0 commit comments

Comments
 (0)