diff --git a/Package.swift b/Package.swift index aef81bc..e90006c 100644 --- a/Package.swift +++ b/Package.swift @@ -27,6 +27,7 @@ let package = Package( .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0"..<"4.0.0"), .package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"), .package(url: "https://github.com/apple/swift-http-types.git", from: "1.2.0"), + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"), ], targets: [ .target( diff --git a/Sources/ContainerImageBuilderPluginDocumentation/README.md b/Sources/ContainerImageBuilderPluginDocumentation/README.md index 42af32f..204a434 100644 --- a/Sources/ContainerImageBuilderPluginDocumentation/README.md +++ b/Sources/ContainerImageBuilderPluginDocumentation/README.md @@ -3,4 +3,10 @@ `ContainerImageBuilderPluginDocumentation` is an otherwise empty target that includes high-level, user-facing documentation about using the ContainerImageBuilder plugin from the command-line. +To preview the documentation, run the following command: + +```bash +swift package --disable-sandbox preview-documentation --target ContainerImageBuilderPlugin +``` +