diff --git a/README.md b/README.md index fc42c77..a00cf5e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,10 @@ This repository provides a GitHub Action for running the [Kani Rust Verifier](https://github.com/model-checking/kani) in CI. -⚠️ **Important Notice**: We will soon be moving the default branch from `main` to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0). -Please be aware that version `0.38` will be the final release on the `main` branch before the transition to `v1`. +⚠️ **Important Notice**: We will be moving to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0), which will install the latest version of `Kani` by default. +Please be aware that version `0.38` will be the final release where the version of `Kani` matches the version of `Kani Github Action`. Make sure to update your workflows and references accordingly. -We have added a new field called `kani-version` that will default to installing the latest version of `kani`. -To install a specific version of 'kani', please add a semver version to the field `kani-version` as shown in the example below. +To install a specific version of `Kani`, please add a semver version to the field `kani-version` as shown in the example below. Example: