Skip to content

Commit 3303b16

Browse files
Prepare documentation for 1.0 release (#6)
Resolves rdar://90124447.
1 parent 6d869df commit 3303b16

File tree

3 files changed

+3
-15
lines changed

3 files changed

+3
-15
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ Please see
99
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
1010
for more detailed usage instructions.
1111

12-
**Note:** The Swift-DocC plugin is under **active-development** and is not ready for production
13-
use.
14-
1512
We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with
1613
the release of Swift `5.6`.
1714

@@ -24,16 +21,15 @@ let package = Package(
2421
// name, platforms, products, etc.
2522
dependencies: [
2623
// other dependencies
27-
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
24+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
2825
],
2926
targets: [
3027
// targets
3128
]
3229
)
3330
```
3431

35-
Swift 5.6 is required in order to run the plugin. Development snapshots that include Swift 5.6
36-
can be found on [Swift.org](https://www.swift.org/download/#snapshots).
32+
Swift 5.6 is required in order to run the plugin.
3733

3834
### Converting Documentation
3935

Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ let package = Package(
1111
// name, platforms, products, etc.
1212
dependencies: [
1313
// other dependencies
14-
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
14+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
1515
],
1616
targets: [
1717
// targets
@@ -20,8 +20,6 @@ let package = Package(
2020
```
2121

2222
> Important: Swift 5.6 is required in order to run the plugin.
23-
> Development snapshots that include Swift 5.6
24-
> can be found on [Swift.org](https://www.swift.org/download/#snapshots).
2523
2624
You can then invoke the plugin from the root of your repository like so:
2725

Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@ Produce Swift-DocC documentation for Swift Package libraries and executables.
77
The Swift-DocC plugin is a Swift Package Manager command plugin that supports building
88
documentation for SwiftPM libraries and executables.
99

10-
> Important: The Swift-DocC plugin is under **active-development** and is not ready for production
11-
> use.
12-
>
13-
> We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with
14-
> the release of Swift `5.6`.
15-
1610
After adding the plugin as a dependency in your Swift package manifest, you can build
1711
documentation for the libraries and executables in that package and its dependencies by running the
1812
following from the command-line:

0 commit comments

Comments
 (0)