Write some POD

[digest-highwayhash.git] / lib / Digest / HighwayHash.pm

diff --git a/lib/Digest/HighwayHash.pm b/lib/Digest/HighwayHash.pm
index 108021b4fc71dd320a1191725316a9a5414cb67f..90fbf097dc09065e6d5185859e3ec04c683e141e 100644 (file)
--- a/lib/Digest/HighwayHash.pm
+++ b/lib/Digest/HighwayHash.pm
@@ -22,7 +22,7 @@ __END__
 
 =head1 NAME
 
-Digest::HighwayHash - fast strong hash function
+Digest::HighwayHash - XS fast strong keyed hash function
 
 =head1 SYNOPSIS
 
@@ -36,9 +36,34 @@ Digest::HighwayHash - fast strong hash function
 
 =head1 DESCRIPTION
 
-HighwayHash is a fast and strong hash function, documented at
+HighwayHash is a fast and strong keyed hash function, documented at
 L<https://github.com/google/highwayhash>.
 
+Three functions are exported by this module, all by default:
+
+=over
+
+=item B<highway_hash64> I<\@key>, I<$input>
+
+Compute the 64-bit HighwayHash of I<$input>, using I<\@key> as a key.
+The key must be a 4-element arrayref, with each element either a
+number or (on Perls without 64-bit numbers) a L<Math::Int64> object. The result is a single number or (on Perls without 64-bit numbers) a L<Math::Int64> object.
+
+=item B<highway_hash128> I<\@key>, I<$input>
+
+Compute the 128-bit HighwayHash of I<$input>, using I<\@key> as a key.
+The key must be a 4-element arrayref, with each element either a
+number or (on Perls without 64-bit numbers) a L<Math::Int64> object. The result is an array of exactly two numbers or (on Perls without 64-bit numbers) L<Math::Int64> objects.
+
+=item B<highway_hash256> I<\@key>, I<$input>
+
+Compute the 256-bit HighwayHash of I<$input>, using I<\@key> as a key.
+The key must be a 4-element arrayref, with each element either a
+number or (on Perls without 64-bit numbers) a L<Math::Int64> object. The result is an array of exactly four numbers or (on Perls without 64-bit numbers) L<Math::Int64> objects.
+
+
+=back
+
 =head1 SEE ALSO
 
 L<https://github.com/google/highwayhash>