diff --git a/README.md b/README.md index 0c43151..83dd763 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ +> [!IMPORTANT] +> **This repository is archived and no longer maintained.** +> +> The version parser here does not implement Semantic Versioning precedence +> correctly (pre-release identifiers are ignored when ordering), and this +> problem is solved well by maintained libraries. +> +> **Use instead:** +> - [`github.com/Masterminds/semver/v3`](https://github.com/Masterminds/semver) — parsing, comparison, and constraint matching (replaces `Version` and `Constraint`). +> - [`golang.org/x/mod/semver`](https://pkg.go.dev/golang.org/x/mod/semver) — if you only need to compare canonical `vX.Y.Z` strings. +> - The `Migration` up/down helper had no third-party equivalent and was only used by `go/sqaffold` (also archived). For database migrations use [`github.com/pressly/goose`](https://github.com/pressly/goose). + +--- + # Go Version A simple library for parsing and comparing versions according to [Semantic Versioning 2.0.0](https://semver.org/).