Skip to content

Commit

Permalink
Named NPM module then-read-stream
Browse files Browse the repository at this point in the history
  • Loading branch information
Borewit committed Jun 20, 2017
1 parent 895d816 commit bee7f35
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ similar as you would read from a file.

## Usage

The `stream-reader` contains one class: `StreamReader`. The constructor of
The `then-read-stream` contains one class: `StreamReader`. The constructor of
the `StreamReader` if provided with the [stream.Readable](https://nodejs.org/api/stream.html#stream_class_stream_readable)
you want to read from.

##### TypeScript:
```JavaScript
import {StreamReader} from "stream-reader";
import {StreamReader} from "then-read-stream";

const readThisStream = ... // Some stream of type stream.Readable
const streamReader = new StreamReader(readThisStream);
Expand All @@ -30,7 +30,7 @@ return streamReader.read(buf, 0, 16).then((bytesRead) => {
```
##### JavaScript:
```JavaScript
var stream_reader = require("stream-reader");
var stream_reader = require("then-read-stream");

var readThisStream = ... // Some stream of type stream.Readable
var streamReader = new stream_reader.StreamReader(readThisStream);
Expand All @@ -47,9 +47,9 @@ return streamReader.read(buf, 0, 16).then( function(bytesRead) {



[npm-url]: https://npmjs.org/package/stream-reader
[npm-image]: https://badge.fury.io/js/stream-reader.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/stream-reader.svg
[npm-url]: https://npmjs.org/package/then-read-stream
[npm-image]: https://badge.fury.io/js/then-read-stream.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/then-read-stream.svg

[travis-url]: https://travis-ci.org/Borewit/stream-reader
[travis-image]: https://api.travis-ci.org/Borewit/stream-reader.svg?branch=master
[travis-url]: https://travis-ci.org/Borewit/then-read-stream
[travis-image]: https://api.travis-ci.org/Borewit/then-read-stream.svg?branch=master
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "stream-reader",
"name": "then-read-stream",
"version": "0.0.2",
"description": "Read from a readable stream just like a file",
"author": {
Expand All @@ -17,13 +17,13 @@
},
"repository": {
"type": "git",
"url": "https://github.com/Borewit/stream-reader"
"url": "https://github.com/Borewit/then-read-stream"
},
"license": "BSD-3-Clause",
"main": "./lib/index.js",
"typings": "lib/index",
"bugs": {
"url": "https://github.com/Borewit/stream-reader/issues"
"url": "https://github.com/Borewit/then-read-stream/issues"
},
"devDependencies": {
"@types/mocha": "^2.2.41",
Expand Down

0 comments on commit bee7f35

Please sign in to comment.