Skip to content

Commit af63e6e

Browse files
authored
Prep docs for alpha.1 (#87)
### Motivation Update docs for the upcoming alpha.1. ### Modifications Updated docs/README. ### Result Ready for alpha.1 ### Test Plan N/A
1 parent 780b888 commit af63e6e

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,10 @@ If both sources are unavailable, the fallback default of `60` is returned.
5656
5757
## Quick start
5858

59-
> Important: While this library's API is still in development, use the `.upToNextMinor(from: "...")` dependency constraint to avoid unexpected build breakages. Before we reach 1.0, API-breaking changes may occur between minor `0.x` versions.
60-
6159
Add the dependency to your `Package.swift`:
6260

6361
```swift
64-
.package(url: "https://github.com/apple/swift-configuration", .upToNextMinor(from: "0.2.0"))
62+
.package(url: "https://github.com/apple/swift-configuration", exact: "1.0.0-alpha.1")
6563
```
6664

6765
Add the library dependency to your target:
@@ -94,7 +92,7 @@ To enable an additional trait on the package, update the package dependency:
9492
```diff
9593
.package(
9694
url: "https://github.com/apple/swift-configuration",
97-
.upToNextMinor(from: "0.2.0"),
95+
exact: "1.0.0-alpha.1",
9896
+ traits: [.defaults, "OtherFeatureSupport"]
9997
)
10098
```

Sources/Configuration/Documentation.docc/Documentation.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,10 @@ These providers can be combined to form a hierarchy, for details check out <doc:
149149

150150
### Quick start
151151

152-
> Important: While this library's API is still in development, use the `.upToNextMinor(from: "...")` dependency constraint to avoid unexpected build breakages. Before we reach 1.0, API-breaking changes may occur between minor `0.x` versions.
153-
154152
Add the dependency to your `Package.swift`:
155153

156154
```swift
157-
.package(url: "https://github.com/apple/swift-configuration", .upToNextMinor(from: "0.2.0"))
155+
.package(url: "https://github.com/apple/swift-configuration", exact: "1.0.0-alpha.1")
158156
```
159157

160158
Add the library dependency to your target:

0 commit comments

Comments
 (0)