Skip to content

Commit c69f0b7

Browse files
Daniel Cousensdcousens
authored andcommitted
README: cleanup
1 parent 482e5d9 commit c69f0b7

2 files changed

Lines changed: 19 additions & 19 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# create-hash
2+
3+
[![Build Status](https://travis-ci.org/crypto-browserify/createHash.svg)](https://travis-ci.org/crypto-browserify/createHash)
4+
5+
Node style hashes for use in the browser, with native hash functions in node.
6+
7+
API is the same as hashes in node:
8+
```js
9+
var createHash = require('create-hash')
10+
var hash = createHash('sha224')
11+
hash.update('synchronous write') // optional encoding parameter
12+
hash.digest() // synchronously get result with optional encoding parameter
13+
14+
hash.write('write to it as a stream')
15+
hash.end() // remember it's a stream
16+
hash.read() // only if you ended it as a stream though
17+
```
18+
19+
To get the JavaScript version even in node do `require('create-hash/browser')`

readme.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)