diff --git a/README.md b/README.md index 5649c443..7d1802da 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,105 @@

-# gulp-cli [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Support us][gittip-image]][gittip-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] -> The streaming build system +# gulp-cli -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/wearefractal/gulp/trend.png)](https://bitdeli.com/free "Bitdeli Badge") +[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] + +Command Line Utility for Gulp + +## Usage + +```bash +> gulp [options] tasks +``` + +## Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagShort FlagDescription
--help-hShow this help.
--version-vPrint the global and local gulp versions.
--require [path]Will require a module before running the gulpfile. This is useful for transpilers but also has other applications.
--gulpfile [path]Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well.
--cwd [path]Manually set the CWD. The search for the gulpfile, as well as the relativity of all requires will be from here.
--verifyWill verify plugins referenced in project's package.json against the plugins blacklist.
--tasks-TPrint the task dependency tree for the loaded gulpfile.
--tasks-simplePrint a plaintext list of tasks for the loaded gulpfile.
--tasks-json [path]Print the task dependency tree, in JSON format, for the loaded gulpfile. The [path] argument is optional, and if given writes the JSON to the path.
--colorWill force gulp and gulp plugins to display colors, even when no color support is detected.
--no-colorWill force gulp and gulp plugins to not display colors, even when color support is detected.
--silent-SSuppress all gulp logging.
--continueContinue execution of tasks upon failure.
--log-level-LSet the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default.
+ +## License + +MIT [gittip-url]: https://www.gittip.com/WeAreFractal/ [gittip-image]: http://img.shields.io/gittip/WeAreFractal.svg @@ -21,3 +116,6 @@ [coveralls-url]: https://coveralls.io/r/gulpjs/gulp-cli [coveralls-image]: http://img.shields.io/coveralls/gulpjs/gulp-cli/master.svg + +[gitter-url]: https://gitter.im/gulpjs/gulp +[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png