Add a READMEHEADmain

1 files changed, 8 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.