diff --git a/README.md b/README.md index bd7ea11..e937724 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # version-up-action -Action that check if an updated version is available. \ No newline at end of file +This action will try to increase the version number as much as possible while downloading the URL. +The last number that can be updated will be returned. + +[URL - https://git.horstenkamp.eu/Philipp/version-up-action.git](https://git.horstenkamp.eu/Philipp/version-up-action/src/branch/main/README.md) + +The folowing arguments should be used: + +- `url-pattern`: The pattern of the url to check. Something like: `https://dl.gitea.com/act_runner/{{VERSION}}/act_runner-{{VERSION}}-linux-arm-7` + Note that the `{{VERSION}}` marker will be replaced by the incremented version number. +- `start-version`: The minimum version to be checked. + Example `0.1.1` Please note that the major update will not be updated.