diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:10:37 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:11:17 +0200 |
commit | 7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch) | |
tree | 70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/create-hmac/README.md | |
parent | aca1143cb9eed16cf37f04e475e4257418dd18ac (diff) |
fix build issues and add typedoc
Diffstat (limited to 'node_modules/create-hmac/README.md')
-rw-r--r-- | node_modules/create-hmac/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/node_modules/create-hmac/README.md b/node_modules/create-hmac/README.md new file mode 100644 index 000000000..73263cfa6 --- /dev/null +++ b/node_modules/create-hmac/README.md @@ -0,0 +1,20 @@ +# create-hmac + +[](https://www.npmjs.org/package/create-hmac) +[](https://travis-ci.org/crypto-browserify/createHmac) +[](https://david-dm.org/crypto-browserify/createHmac#info=dependencies) + +[](https://github.com/feross/standard) + +Node style HMACs for use in the browser, with native HMAC functions in node. API is the same as HMACs in node: + +```js +var createHmac = require('create-hmac') +var hmac = createHmac('sha224', new Buffer("secret key")) +hmac.update('synchronous write') //optional encoding parameter +hmac.digest() // synchronously get result with optional encoding parameter + +hmac.write('write to it as a stream') +hmac.end() //remember it's a stream +hmac.read() //only if you ended it as a stream though +``` |