Skip to content

Commit c8a44d8

Browse files
authored
Merge pull request apple#206 from glessard/1.4.0-readme
[1.4.0] Updates to the README file
2 parents 234e153 + b80d743 commit c8a44d8

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To use the `SystemPackage` library in a SwiftPM project,
3232
add the following line to the dependencies in your `Package.swift` file:
3333

3434
```swift
35-
.package(url: "https://github.com/apple/swift-system", from: "1.3.0"),
35+
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
3636
```
3737

3838
Finally, include `"SystemPackage"` as a dependency for your executable target:
@@ -41,7 +41,7 @@ Finally, include `"SystemPackage"` as a dependency for your executable target:
4141
let package = Package(
4242
// name, platforms, products, etc.
4343
dependencies: [
44-
.package(url: "https://github.com/apple/swift-system", from: "1.3.0"),
44+
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
4545
// other dependencies
4646
],
4747
targets: [
@@ -55,7 +55,15 @@ let package = Package(
5555

5656
## Source Stability
5757

58-
The Swift System package is source stable. The version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version.
58+
At this time, the Swift System package supports three types of operating systems: Darwin-based, POSIX-like, and Windows. The source-stability status of the package differs according to the platform:
59+
60+
| Platform type | Source Stability |
61+
| ----------------- | --------------- |
62+
| Darwin (macOS, iOS, etc.) | Stable |
63+
| POSIX (Linux, WASI, etc.) | Stable |
64+
| Windows | Unstable |
65+
66+
The package version numbers follow [Semantic Versioning][semver] -- source breaking changes to source-stable public API can only land in a new major version. However, platforms for which support has not reached source stability may see source-breaking changes in a new minor version.
5967

6068
[semver]: https://semver.org
6169

@@ -79,7 +87,7 @@ The following table maps existing package releases to their minimum required Swi
7987
| Package version | Swift version | Xcode release |
8088
| ----------------------- | --------------- | ------------- |
8189
| swift-system 1.3.x | >= Swift 5.8 | >= Xcode 14.3 |
82-
| swift-system 1.4.x (unreleased) | >= Swift 5.9 | >= Xcode 15.0 |
90+
| swift-system 1.4.x | >= Swift 5.9 | >= Xcode 15.0 |
8391

8492
We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate. Accordingly, from time to time, new versions of this package require clients to upgrade to a more recent Swift toolchain release. (This allows the package to make use of new language/stdlib features, build on compiler bug fixes, and adopt new package manager functionality as soon as they are available.) Patch (i.e., bugfix) releases will not increase the required toolchain version, but any minor (i.e., new feature) release may do so.
8593

0 commit comments

Comments
 (0)