From c0304d1d1095595e824f58bc120c5c836a93dce1 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Fri, 7 Jul 2017 02:46:20 +0200 Subject: [PATCH] update README --- README.md | 22 +++++++++---- docs/index.md | 47 +++++++++++++++++++++++++++ package.json | 4 +-- yarn.lock | 89 ++++++++++++++++++++++++++++++++++++++++++++++++--- 4 files changed, 150 insertions(+), 12 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index 410c5e6..e323e11 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,15 @@ simplifies access to node streams, TypeScript ready! ## Availabililty -[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstream) -[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartstream) -[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstream) -[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstream/gitbook) +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstream) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartstream) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstream) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstream/) ## Status for master -[![build status](https://gitlab.com/pushrocks/smartstream/badges/master/build.svg)](https://gitlab.com/pushrocks/smartstream/commits/master) -[![coverage report](https://gitlab.com/pushrocks/smartstream/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartstream/commits/master) +[![build status](https://GitLab.com/pushrocks/smartstream/badges/master/build.svg)](https://GitLab.com/pushrocks/smartstream/commits/master) +[![coverage report](https://GitLab.com/pushrocks/smartstream/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartstream/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/smartstream.svg)](https://www.npmjs.com/package/smartstream) [![Dependency Status](https://david-dm.org/pushrocks/smartstream.svg)](https://david-dm.org/pushrocks/smartstream) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstream/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstream/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/pushrocks/smartstream/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstream) @@ -17,6 +18,9 @@ simplifies access to node streams, TypeScript ready! [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) +## Usage +Use TypeScript for best in class instellisense. + ## Usage We recommend the use of TypeScript for best in class intellisense support. @@ -35,3 +39,9 @@ myStream.onCustomEvent('myeventname', (args...) => { /* Do something */ }) // em 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) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) + +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://lossless.com) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e323e11 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,47 @@ +# smartstream +simplifies access to node streams, TypeScript ready! + +## Availabililty +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstream) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartstream) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstream) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstream/) + +## Status for master +[![build status](https://GitLab.com/pushrocks/smartstream/badges/master/build.svg)](https://GitLab.com/pushrocks/smartstream/commits/master) +[![coverage report](https://GitLab.com/pushrocks/smartstream/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartstream/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/smartstream.svg)](https://www.npmjs.com/package/smartstream) +[![Dependency Status](https://david-dm.org/pushrocks/smartstream.svg)](https://david-dm.org/pushrocks/smartstream) +[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstream/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstream/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/pushrocks/smartstream/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstream) +[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) +[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) +[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) + +## Usage +Use TypeScript for best in class instellisense. + +## Usage +We recommend the use of TypeScript for best in class intellisense support. + +```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) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) + +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://lossless.com) diff --git a/package.json b/package.json index 6d78298..1dc8113 100644 --- a/package.json +++ b/package.json @@ -18,11 +18,11 @@ }, "homepage": "https://gitlab.com/pushrocks/smartstream#README", "devDependencies": { - "tapbundle": "^1.0.14" + "tapbundle": "^1.1.0" }, "dependencies": { "@types/through2": "^2.0.33", - "smartq": "^1.1.1", + "smartq": "^1.1.6", "through2": "^2.0.3", "typings-global": "^1.0.19" } diff --git a/yarn.lock b/yarn.lock index 97c0b61..9825ee1 100644 --- a/yarn.lock +++ b/yarn.lock @@ -113,6 +113,13 @@ deep-eql@^0.1.3: dependencies: type-detect "0.1.1" +define-properties@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.1.2.tgz#83a73f2fea569898fb737193c8f873caf6d45c94" + dependencies: + foreach "^2.0.5" + object-keys "^1.0.8" + early@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/early/-/early-2.1.1.tgz#841e23254ea5dc54d8afaeee82f5ab65c00ee23c" @@ -121,14 +128,39 @@ early@^2.1.1: smartq "^1.1.1" typings-global "^1.0.16" +es-abstract@^1.5.1: + version "1.7.0" + resolved "https://registry.yarnpkg.com/es-abstract/-/es-abstract-1.7.0.tgz#dfade774e01bfcd97f96180298c449c8623fb94c" + dependencies: + es-to-primitive "^1.1.1" + function-bind "^1.1.0" + is-callable "^1.1.3" + is-regex "^1.0.3" + +es-to-primitive@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/es-to-primitive/-/es-to-primitive-1.1.1.tgz#45355248a88979034b6792e19bb81f2b7975dd0d" + dependencies: + is-callable "^1.1.1" + is-date-object "^1.0.1" + is-symbol "^1.0.1" + es6-error@^4.0.2: version "4.0.2" resolved "https://registry.yarnpkg.com/es6-error/-/es6-error-4.0.2.tgz#eec5c726eacef51b7f6b73c20db6e1b13b069c98" +foreach@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.5.tgz#0bee005018aeb260d0a3af3ae658dd0136ec1b99" + fs.realpath@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" +function-bind@^1.0.2, function-bind@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.0.tgz#16176714c801798e4e8f2cf7f7529467bb4a5771" + glob@^7.0.0: version "7.1.2" resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.2.tgz#c19c9df9a028702d678612384a6552404c636d15" @@ -140,6 +172,12 @@ glob@^7.0.0: once "^1.3.0" path-is-absolute "^1.0.0" +has@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/has/-/has-1.0.1.tgz#8461733f538b0837c9361e39a9ab9e9704dc2f28" + dependencies: + function-bind "^1.0.2" + inflight@^1.0.4: version "1.0.6" resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" @@ -155,6 +193,24 @@ interpret@^1.0.0: version "1.0.3" resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.0.3.tgz#cbc35c62eeee73f19ab7b10a801511401afc0f90" +is-callable@^1.1.1, is-callable@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/is-callable/-/is-callable-1.1.3.tgz#86eb75392805ddc33af71c92a0eedf74ee7604b2" + +is-date-object@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-date-object/-/is-date-object-1.0.1.tgz#9aa20eb6aeebbff77fbd33e74ca01b33581d3a16" + +is-regex@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/is-regex/-/is-regex-1.0.4.tgz#5517489b547091b0930e095654ced25ee97e9491" + dependencies: + has "^1.0.1" + +is-symbol@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-symbol/-/is-symbol-1.0.1.tgz#3cc59f00025194b6ab2e38dbae6689256b660572" + isarray@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" @@ -198,6 +254,17 @@ nan@^2.3.2: version "2.6.2" resolved "https://registry.yarnpkg.com/nan/-/nan-2.6.2.tgz#e4ff34e6c95fdfb5aecc08de6596f43605a7db45" +object-keys@^1.0.8: + version "1.0.11" + resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-1.0.11.tgz#c54601778ad560f1142ce0e01bcca8b56d13426d" + +object.getownpropertydescriptors@^2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz#8758c846f5b407adab0f236e0986f14b051caa16" + dependencies: + define-properties "^1.1.2" + es-abstract "^1.5.1" + once@^1.3.0: version "1.4.0" resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" @@ -285,6 +352,13 @@ smartq@^1.1.1: typed-promisify "^0.3.0" typings-global "^1.0.14" +smartq@^1.1.6: + version "1.1.6" + resolved "https://registry.yarnpkg.com/smartq/-/smartq-1.1.6.tgz#0c1ff4336d95e95b4f1fdd8ccd7e2c5a323b8412" + dependencies: + typings-global "^1.0.19" + util.promisify "^1.0.0" + smartshell@^1.0.6: version "1.0.8" resolved "https://registry.yarnpkg.com/smartshell/-/smartshell-1.0.8.tgz#1535756c0fe8069f7e6da1e3f9cb6c8f77094e42" @@ -302,16 +376,16 @@ string_decoder@~1.0.3: dependencies: safe-buffer "~5.1.0" -tapbundle@^1.0.14: - version "1.0.14" - resolved "https://registry.yarnpkg.com/tapbundle/-/tapbundle-1.0.14.tgz#75827e335fcb02216f0267a26a26d702ddc02e3c" +tapbundle@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/tapbundle/-/tapbundle-1.1.0.tgz#e0547f683ae36260f639ecd7435df95f0af01683" dependencies: early "^2.1.1" leakage "^0.3.0" smartchai "^1.0.3" smartdelay "^1.0.3" smartq "^1.1.1" - typings-global "^1.0.16" + typings-global "^1.0.19" through2@^2.0.3: version "2.0.3" @@ -343,6 +417,13 @@ util-deprecate@~1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" +util.promisify@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/util.promisify/-/util.promisify-1.0.0.tgz#440f7165a459c9a16dc145eb8e72f35687097030" + dependencies: + define-properties "^1.1.2" + object.getownpropertydescriptors "^2.0.3" + which@^1.2.14: version "1.2.14" resolved "https://registry.yarnpkg.com/which/-/which-1.2.14.tgz#9a87c4378f03e827cecaf1acdf56c736c01c14e5"