Skip to content

Commit 7e0b0c9

Browse files
authored
Prep docs for 1.0 (#94)
### Motivation Docs were still referencing 1.0.0-alpha.1, but as we're tagging 1.0 soon, update the docs accordingly. ### Modifications Updated docs. Also removed the claim that Configuration supports Windows yet, since our Windows toolchains in CI are crashing when building Configuration. Once that's fixed and we enable CI, we'll re-add it. ### Result More accurate docs. ### Test Plan N/A
1 parent f55d45c commit 7e0b0c9

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

Examples/hello-world-cli-example/Package.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ let package = Package(
1010
dependencies: [
1111
.package(
1212
url: "https://github.com/apple/swift-configuration",
13+
// TODO: Update once 1.0.0 is tagged.
1314
exact: "1.0.0-alpha.1",
1415
traits: [.defaults, "CommandLineArgumentsSupport"]
1516
)

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If both sources are unavailable, the fallback default of `60` is returned.
5959
Add the dependency to your `Package.swift`:
6060

6161
```swift
62-
.package(url: "https://github.com/apple/swift-configuration", exact: "1.0.0-alpha.1")
62+
.package(url: "https://github.com/apple/swift-configuration", from: "1.0.0")
6363
```
6464

6565
Add the library dependency to your target:
@@ -92,7 +92,7 @@ To enable an additional trait on the package, update the package dependency:
9292
```diff
9393
.package(
9494
url: "https://github.com/apple/swift-configuration",
95-
exact: "1.0.0-alpha.1",
95+
from: "1.0.0",
9696
+ traits: [.defaults, "OtherFeatureSupport"]
9797
)
9898
```
@@ -106,9 +106,9 @@ Available traits:
106106

107107
## Supported platforms and minimum versions
108108

109-
The library is supported on macOS, Linux, and Windows.
109+
The library is supported on Apple platforms and Linux.
110110

111-
| Component | macOS | Linux, Windows | iOS | tvOS | watchOS | visionOS |
111+
| Component | macOS | Linux | iOS | tvOS | watchOS | visionOS |
112112
| ------------- | ----- | -------------- | --- | ---- | ------- | -------- |
113113
| Configuration | ✅ 15+ || ✅ 18+ | ✅ 18+ | ✅ 11+ | ✅ 2+ |
114114

Sources/Configuration/Documentation.docc/Documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ These providers can be combined to form a hierarchy, for details check out <doc:
152152
Add the dependency to your `Package.swift`:
153153

154154
```swift
155-
.package(url: "https://github.com/apple/swift-configuration", exact: "1.0.0-alpha.1")
155+
.package(url: "https://github.com/apple/swift-configuration", from: "1.0.0")
156156
```
157157

158158
Add the library dependency to your target:
@@ -179,7 +179,7 @@ To enable an additional trait on the package, update the package dependency:
179179
```diff
180180
.package(
181181
url: "https://github.com/apple/swift-configuration",
182-
exact: "...",
182+
from: "1.0.0",
183183
+ traits: [.defaults, "OtherFeatureSupport"]
184184
)
185185
```
@@ -193,9 +193,9 @@ Available traits:
193193

194194
### Supported platforms and minimum versions
195195

196-
The library is supported on macOS, Linux, and Windows.
196+
The library is supported on Apple platforms and Linux.
197197

198-
| Component | macOS | Linux, Windows | iOS | tvOS | watchOS | visionOS |
198+
| Component | macOS | Linux | iOS | tvOS | watchOS | visionOS |
199199
| ------------- | ----- | -------------- | --- | ---- | ------- | -------- |
200200
| Configuration | ✅ 15+ || ✅ 18+ | ✅ 18+ | ✅ 11+ | ✅ 2+ |
201201

0 commit comments

Comments
 (0)