Skip to content

Commit ce8b491

Browse files
committed
Update README for 1.0
1 parent 39774ef commit ce8b491

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,7 @@ To use the `SystemPackage` library in a SwiftPM project,
2828
add the following line to the dependencies in your `Package.swift` file:
2929

3030
```swift
31-
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
32-
```
33-
34-
Because `SystemPackage` is under active development,
35-
source-stability is only guaranteed within minor versions (e.g. between `0.0.3` and `0.0.4`).
36-
If you don't want potentially source-breaking package updates,
37-
use this dependency specification instead:
38-
39-
```swift
40-
.package(url: "https://github.com/apple/swift-system", .upToNextMinor(from: "0.0.1")),
31+
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
4132
```
4233

4334
Finally, include `"SystemPackage"` as a dependency for your executable target:
@@ -46,7 +37,7 @@ Finally, include `"SystemPackage"` as a dependency for your executable target:
4637
let package = Package(
4738
// name, platforms, products, etc.
4839
dependencies: [
49-
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
40+
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
5041
// other dependencies
5142
],
5243
targets: [
@@ -58,6 +49,12 @@ let package = Package(
5849
)
5950
```
6051

52+
## Source Stability
53+
54+
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.
55+
56+
[semver]: https://semver.org
57+
6158
## Contributing
6259

6360
Before contributing, please read [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)