From edc4f7e32f9630291b120d8a59410e094dfbae9c Mon Sep 17 00:00:00 2001 From: Mieszko Grodzicki Date: Sat, 31 Dec 2022 14:44:23 +0100 Subject: [PATCH] New structure of README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0187de6..87959b3 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,22 @@ Single-crate workspaces can use it as: run: # your `cargo publish` code here ``` +# Input options + +Every argument is optional. + +| Input | Description | Default | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------| +| crate-name | The crate whose API to check for semver | | +| crate-target | By default, check the library target of the crate. To check a different target (e.g. a binary target), set this to `--bin ` | `--lib` | +| version-tag-prefix | The prefix to use for the git tag for a version; the default "v" creates tags like "v1.0.0" | `v` | + +# Scenarios + +- [Use with a different version tag format](#use-with-a-different-version-tag-format) +- [Use in workspaces with more than one crate](#use-in-workspaces-with-more-than-one-crate) +- [Use with binary crates or crates with more than one target](#use-with-binary-crates-or-crates-with-more-than-one-target) + ## Use with a different version tag format Change the `version-tag-prefix` setting to reflect the prefix used to create the version tag. The setting's default value `'v'` creates version tags like `v1.2.3`.