feat: Working on command-line documentation.
Some checks failed
CI / Ubuntu (push) Has been cancelled
Some checks failed
CI / Ubuntu (push) Has been cancelled
This commit is contained in:
18
Sources/CliClient/Documentation.docc/CliClient.md
Normal file
18
Sources/CliClient/Documentation.docc/CliClient.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# ``CliClient``
|
||||
|
||||
Derive a version for a command-line tool from git tags or a git sha.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
[Github Repo](https://github.com/m-housh/swift-cli-version)
|
||||
|
||||
## Overview
|
||||
|
||||
This tool exposes several plugins that can be used to derive a version for a command line program at
|
||||
build time or by manually running the plugin. The version is generally derived from git tags,
|
||||
however it can be configured to run custom commands.
|
||||
|
||||
## Articles
|
||||
|
||||
- <doc:GettingStarted>
|
||||
- <doc:ManualPlugins>
|
||||
Reference in New Issue
Block a user