Skip to content

Commit

Permalink
Merge pull request #17 from dudleycarr/bump-version-fix-readme
Browse files Browse the repository at this point in the history
Bump version to 1.0. Fix README examples.
  • Loading branch information
dudleycarr committed Sep 3, 2017
2 parents 36ba7c6 + dcfd26d commit 5186f9f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,28 @@ SnappyStream and UnsnappyStream are

```javascript
const {SnappyStream} = require('snappystream')
const fs = require('fs')

const in = fs.createReadStream('snappy.txt')
const inStream = fs.createReadStream('snappy.txt')
const snappyStream = new SnappyStream()
const out = fs.createWriteStream('snappy_frame.txt')
const outStream = fs.createWriteStream('snappy_frame.txt')

in.pipe(snappyStream).pipe(out)
inStream.pipe(snappyStream).pipe(outStream)
```

UnsnappyStream constructor takes an optional argument ```verifyChecksums```
which is false by default.

```javascript
const {UnsnappyStream} = require('snappysteam')
const fs = require('fs')

const in = fs.createReadStream('snappy_frame.txt')
const inStream = fs.createReadStream('snappy_frame.txt')
const unsnappyStream = new UnsnappyStream(true)

unsnappyStream.on('end', function() {
console.log(unsnappyStream.read())
})

in.pipe(unsnappyStream)
inStream.pipe(unsnappyStream)
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "snappystream",
"version": "0.4.0",
"version": "1.0.0",
"description": "Framed Snappy streams",
"main": "lib/snappystreams.js",
"scripts": {
Expand Down

0 comments on commit 5186f9f

Please sign in to comment.