Add a READMEHEADmain

2 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7edc98
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# KMAC
+
+KMAC128 and KMAC256 are message authentication codes defined by NIST in
+https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-185.pdf. The
+implementation here is based on the `crypto/sha3` package from the Go
+standard library.
+
+I do not recommend using this package. Consider using `crypto/hmac` instead.
diff --git a/kmac.go b/kmac.go
index 10cae94..e3f55a2 100644
--- a/kmac.go
+++ b/kmac.go
@@ -16,6 +16,11 @@
 // It may include the identities of the parties who are deriving and/or using
 // the derived keying material and, optionally, a nonce known by the parties who
 // derive the keys. Use the string "KDF" for optionalCustomizationString.
+//
+// # Disclaimer
+//
+// This package has not been reviewed by security experts. Consider using
+// crypto/hmac instead.
 package kmac
 
 import (