diff --git a/README.md b/README.md index c387049..5b319e4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +> [!IMPORTANT] +> **This repository is archived and no longer maintained.** +> +> The implementation uses `math/rand`, which is not suitable for anything +> security-sensitive, and `Password` has correctness bugs. +> +> **Use instead:** +> - [`crypto/rand`](https://pkg.go.dev/crypto/rand) for tokens, passwords, and anything security-sensitive. +> - [`github.com/matoous/go-nanoid/v2`](https://github.com/matoous/go-nanoid) or [`github.com/google/uuid`](https://github.com/google/uuid) for identifiers. + +--- + # Go Random Functions to create random values. That's about the size of it.