📝 Add MessageDigest/JDK version note.

jwojnowski · Jan 28, 2024 · 1330a3f · 1330a3f
1 parent 4e101f7
commit 1330a3f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,10 @@ There are three options for length of the generated ID:
 2. `Cuid2Long` - 32 characters
 3. `Cuid2Custom[n]` - custom length (parametrised using literal types, e.g. `Cuid2Custom[10]` or `Cuid2Custom[27]`)
 
+### Note on SHA3 support
+This library uses SHA3, which is available from JDK 9 (b119) onwards. Alternative implementation can be provided via
+`Cuid2Gen.custom`.
+
 ## Validation
 ```scala
 val idDefault: Option[Cuid2]                = Cuid2.validate("r0o5ncoizclu1b9iraz620cn")