feat: Working on documentation
All checks were successful
CI / Run tests. (push) Successful in 58s

This commit is contained in:
2024-12-09 09:35:17 -05:00
parent 78a632c3e5
commit 875b1980e0
9 changed files with 100 additions and 8 deletions

26
Examples/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")
]
)
]
)
```