push.rocks/gulp-function
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Philipp Kunz 2016-10-19 00:47:29 +02:00
parent a8c3fa048a
commit af68a92702
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -19,12 +19,12 @@ accepts call to execute in gulp pipeline.
### Usage ### Usage
```javascript ```javascript
var gulp = require("gulp"); let gulp = require("gulp");
var gulpFunction = require("gulp-function"); let gulpFunction = require("gulp-function");
var Q = require("q"); let Q = require("q");
var myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object
var done = Q.defer(); let done = Q.defer();
console.log("Hello World!") console.log("Hello World!")
// NOTE: // NOTE:
@ -36,7 +36,7 @@ var myFunction = function (file, enc) { // file and enc are optional in case you
} }
gulp.task('gulpTest',function() { gulp.task('gulpTest',function() {
var stream = gulp.src('./mydir/*.something') let stream = gulp.src('./mydir/*.something')
.pipe(gulpFunction(myFunction,'forEach')) //read the notes below .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
.pipe(gulp.dest("./build/")); .pipe(gulp.dest("./build/"));
return stream; // by returning the stream gulp knows when our task has finished. return stream; // by returning the stream gulp knows when our task has finished.