add doc.go, fixes #6

capitalone · Aug 21, 2017 · ac23aa0 · ac23aa0
1 parent e98a868
commit ac23aa0
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc.go b/doc.go
@@ -0,0 +1,9 @@
+/*
+Package fpe implements the NIST recommended Format Preserving Encryption (FPE) FF1 and FF3 algorithms.
+
+NIST Recommendation SP 800-38G: http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-38G.pdf
+
+This package itself has nothing, the ff1 and ff3 sub-packages contain the API.
+
+*/
+package fpe