summaryrefslogtreecommitdiffstats
path: root/node_modules/create-hash/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/create-hash/README.md')
-rw-r--r--node_modules/create-hash/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/node_modules/create-hash/README.md b/node_modules/create-hash/README.md
new file mode 100644
index 0000000..bad028d
--- /dev/null
+++ b/node_modules/create-hash/README.md
@@ -0,0 +1,19 @@
+# create-hash
+
+[![Build Status](https://travis-ci.org/crypto-browserify/createHash.svg)](https://travis-ci.org/crypto-browserify/createHash)
+
+Node style hashes for use in the browser, with native hash functions in node.
+
+API is the same as hashes in node:
+```js
+var createHash = require('create-hash')
+var hash = createHash('sha224')
+hash.update('synchronous write') // optional encoding parameter
+hash.digest() // synchronously get result with optional encoding parameter
+
+hash.write('write to it as a stream')
+hash.end() // remember it's a stream
+hash.read() // only if you ended it as a stream though
+```
+
+To get the JavaScript version even in node do `require('create-hash/browser')`