diff --git a/.gitignore b/.gitignore index 574444a..fd1962e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,5 @@ node_modules/ npm-debug.log test/result/ coverage/ -docs/ pages/ public diff --git a/README.md b/README.md index ea1249e..83ac6aa 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ browserify and other goodies for gulp ## Availabililty -[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-browser) -[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-browser) -[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-browser) -[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-browser/) +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-browser) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-browser) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-browser) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-browser/) ## Status for master [![build status](https://GitLab.com/pushrocks/gulp-browser/badges/master/build.svg)](https://GitLab.com/pushrocks/gulp-browser/commits/master) @@ -21,6 +21,7 @@ browserify and other goodies for gulp ## Usage Use TypeScript for best in class instellisense. + #### Browserify: ```javascript let gulp = require("gulp"); @@ -47,4 +48,9 @@ Use TypeScript for best in class instellisense. * [Phil Kunz](https://github.com/philkunz) * [Steffan Donal](https://github.com/SteffanDonal) -[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) +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://push.rocks) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..83ac6aa --- /dev/null +++ b/docs/index.md @@ -0,0 +1,56 @@ +# gulp-browser +browserify and other goodies for gulp + +## Availabililty +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-browser) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-browser) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-browser) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-browser/) + +## Status for master +[![build status](https://GitLab.com/pushrocks/gulp-browser/badges/master/build.svg)](https://GitLab.com/pushrocks/gulp-browser/commits/master) +[![coverage report](https://GitLab.com/pushrocks/gulp-browser/badges/master/coverage.svg)](https://GitLab.com/pushrocks/gulp-browser/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/gulp-browser.svg)](https://www.npmjs.com/package/gulp-browser) +[![Dependency Status](https://david-dm.org/pushrocks/gulp-browser.svg)](https://david-dm.org/pushrocks/gulp-browser) +[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/gulp-browser/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/gulp-browser/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/pushrocks/gulp-browser/badges/code.svg)](https://www.bithound.io/github/pushrocks/gulp-browser) +[![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. + + +#### Browserify: +```javascript + let gulp = require("gulp"); + let gulpBrowser = require("gulp-browser"); + + let transforms = [ + { + transform: "babelify", + options: {presets: ["es2015"]} + } + ]; + + gulp.task('gulpBrowserTest',function() { + var stream = gulp.src('./test/*.js') + .pipe(gulpBrowser.browserify(transforms)) // gulp.browserify() accepts an optional array of tansforms + .pipe(gulp.dest("./test/browserifiedJS/")); + return stream; + }); +``` + +> **Note:** Be aware of how gulp.src creates values of file.base and file.path since that is important to the require statements. + +### Contributors +* [Phil Kunz](https://github.com/philkunz) +* [Steffan Donal](https://github.com/SteffanDonal) + +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://push.rocks)