feat: Fixes readme in wrong location.
All checks were successful
CI / Run tests. (push) Successful in 56s

This commit is contained in:
2024-12-09 09:37:10 -05:00
parent 875b1980e0
commit 10ced39b62

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
# swift-cli-doc
A tool for building rich documentation for command line applications using result builders and
syntax similar to `SwiftUI`.
## Getting Started
Add this as a package dependency to your command line application.
```swift
let package = Package(
name: "my-tool"
...
dependencies: [
.package(url: "https://git.housh.dev/michael/swift-cli-doc", from: "0.1.0")
],
targets: [
.executableTarget(
name: "my-tool",
dependencies: [
.product(name: "CliDoc", package: "swift-cli-doc")
]
)
]
)
```