fix(docs): update

This commit is contained in:
Philipp Kunz 2019-02-20 00:40:31 +01:00
parent d759e2a562
commit 2818420ee9
3 changed files with 17 additions and 5 deletions

View File

@ -20,6 +20,21 @@ simplifies access to node streams
Use TypeScript for best in class instellisense.
```typescript
import { Smartstream } from 'smartstream'
import * as gUglify from 'gulp-uglify'
let mySmartstream = new Smartstream([
gulp.src(['./file1.js','./file2.js']),
gUglify(),
gulp.dest('./some/output/path')
])
mySmartstream.onError((err) => { /* handle error */ }) // handles all errors in stream
myStream.onCustomEvent('myeventname', (args...) => { /* Do something */ }) // emit an custom event anywhere in your stream
mySmartstream.run().then(() => {/* do something when stream is finished */})
```
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

View File

@ -31,4 +31,4 @@
"@types/through2": "^2.0.34",
"through2": "^3.0.0"
}
}
}

View File

@ -1,7 +1,4 @@
import * as smartpromise from '@pushrocks/smartpromise';
import * as through2 from 'through2';
export {
smartpromise,
through2
};
export { smartpromise, through2 };