Skip to content

Commit

Permalink
Prepare documentation for 1.0 release (#6)
Browse files Browse the repository at this point in the history
Resolves rdar://90124447.
  • Loading branch information
ethan-kusters committed Mar 14, 2022
1 parent 6d869df commit 3303b16
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 15 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ Please see
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
for more detailed usage instructions.

**Note:** The Swift-DocC plugin is under **active-development** and is not ready for production
use.

We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with
the release of Swift `5.6`.

Expand All @@ -24,16 +21,15 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// targets
]
)
```

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

### Converting Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// targets
Expand All @@ -20,8 +20,6 @@ let package = Package(
```

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ Produce Swift-DocC documentation for Swift Package libraries and executables.
The Swift-DocC plugin is a Swift Package Manager command plugin that supports building
documentation for SwiftPM libraries and executables.

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

0 comments on commit 3303b16

Please sign in to comment.