Skip to content

Commit

Permalink
Adjust README
Browse files Browse the repository at this point in the history
  • Loading branch information
ffried committed May 2, 2022
1 parent 625da6d commit 00ecbac
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

This action generates documentation for a Swift package using `docc`.

**Important:** The package must use the [Swift-DocC Plugin](https://github.com/apple/swift-docc-plugin).
**Important:** The package must use the [Swift-DocC Plugin](https://github.com/apple/swift-docc-plugin) unless `xcodebuild` is used!

**Note:** Version 2 of this action replaced `jazzy` with `docc`! Use `@v1` to use `jazzy`.

## Inputs

Expand Down

0 comments on commit 00ecbac

Please sign in to comment.