Skip to content

Commit

Permalink
Update README for 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
milseman committed Sep 1, 2021
1 parent 39774ef commit ce8b491
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,7 @@ To use the `SystemPackage` library in a SwiftPM project,
add the following line to the dependencies in your `Package.swift` file:

```swift
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
```

Because `SystemPackage` is under active development,
source-stability is only guaranteed within minor versions (e.g. between `0.0.3` and `0.0.4`).
If you don't want potentially source-breaking package updates,
use this dependency specification instead:

```swift
.package(url: "https://github.com/apple/swift-system", .upToNextMinor(from: "0.0.1")),
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
```

Finally, include `"SystemPackage"` as a dependency for your executable target:
Expand All @@ -46,7 +37,7 @@ Finally, include `"SystemPackage"` as a dependency for your executable target:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
// other dependencies
],
targets: [
Expand All @@ -58,6 +49,12 @@ let package = Package(
)
```

## Source Stability

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.

[semver]: https://semver.org

## Contributing

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

0 comments on commit ce8b491

Please sign in to comment.