Skip to content

Commit eeeb81d

Browse files
committed
[readme] update usage example, reword stability
1 parent 11d4812 commit eeeb81d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 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,15 +55,15 @@ let package = Package(
5555

5656
## Source Stability
5757

58-
The Swift System package supports three types of operating systems: Darwin, POSIX, and Windows. The source-stability status of the package differs according to the platform:
58+
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:
5959

60-
| Platform type | Stability |
60+
| Platform type | Source Stability |
6161
| ----------------- | --------------- |
62-
| Darwin | Source stable |
63-
| POSIX | Source stable |
64-
| Windows | Source unstable |
62+
| Darwin (macOS, iOS, etc.) | Stable |
63+
| POSIX (Linux, WASI, etc.) | Stable |
64+
| Windows | Unstable |
6565

66-
The package version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version. However, platforms for which support has not reached source stability can have source-breaking changes in a new minor version.
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.
6767

6868
[semver]: https://semver.org
6969

0 commit comments

Comments
 (0)