Skip to content

Commit

Permalink
updated readme and tests ready for 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
yoosername committed Nov 19, 2017
1 parent fea6012 commit b4968aa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
## Installation

```bash
npm install
npm install streaming-middleware
```

## Usage

An instance of StreamingMiddleware is a type of Duplex Stream which internally writes data to and reads data from a chain of Transform streams that are piped through dynamically in the order you add them.

```javascript
var StreamingMiddleware = require("../StreamingMiddleware.js");
var StreamingMiddleware = require("streaming-middleware");
var app = StreamingMiddleware();

app
Expand Down
8 changes: 4 additions & 4 deletions examples/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ npm install
## Simple pipe from STDIN to STDOUT

```javascript
var StreamingMiddleware = require("../lib/StreamingMiddleware.js");
var StreamingMiddleware = require("streaming-middleware");
var app = StreamingMiddleware();

app
Expand Down Expand Up @@ -42,7 +42,7 @@ echo "tiny rick" | node simple-pipe.js # KCIR YNIT
```javascript
var program = require('commander');
var path = require("path");
var StreamingMiddleware = require("../StreamingMiddleware.js");
var StreamingMiddleware = require("streaming-middleware");
var app = StreamingMiddleware();

function addMiddlewareToStack(middleware, collection) {
Expand Down Expand Up @@ -94,7 +94,7 @@ echo "pickle rick" | node simple-cli.js -p ./plugins/uppercase.js -p ./plugins/r
```javascript
const WritableBulk = require('elasticsearch-streams').WritableBulk;
const random = require('random-document-stream');
var app = require("../lib/StreamingMiddleware.js")();
var app = require("streaming-middleware")();

function addMiddlewareToStack(middleware) {
"use strict";
Expand Down Expand Up @@ -167,7 +167,7 @@ node ./elasticsearch-upload.js -a 5 -h localhost -p 32769 -i test -t ./plugins/t

```javascript
const cli = require('commander');
const StreamingMiddleware = require("../lib/StreamingMiddleware.js");
const StreamingMiddleware = require("streaming-middleware");
const app = StreamingMiddleware();
const ReadableSearch = require('elasticsearch-streams').ReadableSearch;

Expand Down
2 changes: 1 addition & 1 deletion examples/simple-cli.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var program = require('commander');
var path = require("path");
var StreamingMiddleware = require("../StreamingMiddleware.js");
var StreamingMiddleware = require("../lib/StreamingMiddleware.js");
var app = StreamingMiddleware();

function addMiddlewareToStack(middleware) {
Expand Down

0 comments on commit b4968aa

Please sign in to comment.