summaryrefslogtreecommitdiff
path: root/ext/hash/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/hash/README')
-rw-r--r--ext/hash/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/ext/hash/README b/ext/hash/README
new file mode 100644
index 000000000..97eb206d0
--- /dev/null
+++ b/ext/hash/README
@@ -0,0 +1,19 @@
+Generic hashing framework for PHP
+
+Simplest usages:
+
+$digest = hash($algoname, $message);
+$digest = hash_file($algoname, $filename);
+
+Examples:
+
+$digest = hash('md5', 'The quick brown fox jumped over the lazy dog.');
+
+Feeder usage:
+
+$context = hash_init($algoname);
+hash_update($context, $message);
+$digest = hash_final($context);
+
+hash(), hash_file(), and hash_final() each support an optional boolean parameter $raw_output which behaves in the same
+manner as sha1()'s optional parameter.