diff --git a/README.md b/README.md index b84c2a1..44e818e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +> [!IMPORTANT] +> **This repository is archived and no longer maintained.** +> +> `Record` is a convenience layer over `map[string]any`. The type coercion +> it provides is covered more completely by existing libraries, and scanning +> into structs is usually the better approach. +> +> **Use instead:** +> - [`github.com/spf13/cast`](https://github.com/spf13/cast) — `cast.ToIntE`, `cast.ToStringE`, etc. for coercing an `any` to a concrete type. +> - [`github.com/jmoiron/sqlx`](https://github.com/jmoiron/sqlx) or plain `database/sql` struct scanning when the source is SQL rows. + +--- + # Go Record Record stores mixed scalar data (Boolean, numeric, and string) and provides type-safe methods to retrieve it. It automatically casts values where possible.