From ad48f166f7071b88ec3435bc87de2ade05dd36c9 Mon Sep 17 00:00:00 2001 From: mromaszewicz Date: Thu, 6 Jun 2024 22:53:18 +0200 Subject: [PATCH] Update readme with install instrctions There are go.mod module name mismatches now that we've moved repos. Mention this in the readme, and inform that v2.3.0 is the first working version in the new location. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6cb6e2e818..7ef5b8dff1 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,15 @@ With `oapi-codegen`, there are a few [Key Design Decisions](#key-design-decision ## Action Required: The repository for this project has changed -As announced in [May 2024](https://github.com/oapi-codegen/oapi-codegen/discussions/1605), we have moved the project from the deepmap organization to our own organization, and you will need to update your import -paths to pull updates past this point. You need to do a recursive search/replace from +As announced in [May 2024](https://github.com/oapi-codegen/oapi-codegen/discussions/1605), +we have moved the project from the deepmap organization to our own organization, and you will need to update your +import paths to pull updates past this point. You need to do a recursive search/replace from `github.com/oapi-codegen/oapi-codegen/v2` to `github.com/oapi-codegen/oapi-codegen/v2`. +`oapi-codegen` moved to its new home with the version tag `v2.3.0`. If you +are installing a version prior to `v2.3.0`, please use `github.com/deepmap/oapi-codegen/v2', +otherwise, use `github.com/oapi-codegen/oapi-codegen/v2` + ## Install It is recommended to follow [the `tools.go` pattern](https://www.jvt.me/posts/2022/06/15/go-tools-dependency-management/) for managing the dependency of `oapi-codegen` alongside your core application.