Skip to content

Commit d5cdd86

Browse files
committed
update readme
1 parent e2f8c23 commit d5cdd86

File tree

1 file changed

+47
-3
lines changed

1 file changed

+47
-3
lines changed

README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,48 @@
1-
undertaker-common-tasks
2-
=======================
1+
<p align="center">
2+
<a href="http://gulpjs.com">
3+
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
4+
</a>
5+
</p>
36

4-
Proof of concept for custom Undertaker registries that pre-define tasks
7+
# undertaker-common-tasks
8+
9+
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Gitter chat][gitter-image]][gitter-url]
10+
11+
Proof-of-concept custom registry that pre-defines tasks.
12+
13+
## Example
14+
15+
```js
16+
var gulp = require('gulp');
17+
var CommonTasks = require('undertaker-common-tasks');
18+
19+
gulp.registry(new CommonTasks({ port: 1337, buildDir: './dist' }));
20+
21+
// 'clean' & 'series' were defined by the registry
22+
gulp.task('default', gulp.series('clean', 'serve'));
23+
```
24+
25+
## API
26+
27+
### CommonTasksRegistry([options])
28+
29+
Constructor for the registry. Pass an instance of this registry to `gulp.registry`.
30+
31+
#### options
32+
33+
* `port` - the port to start a static webserver on.
34+
* `buildDir` - the output directory (clean deletes this directory).
35+
36+
## License
37+
38+
MIT
39+
40+
[downloads-image]: http://img.shields.io/npm/dm/undertaker-common-tasks.svg
41+
[npm-url]: https://npmjs.org/package/undertaker-common-tasks
42+
[npm-image]: http://img.shields.io/npm/v/undertaker-common-tasks.svg
43+
44+
[travis-url]: https://travis-ci.org/gulpjs/undertaker-common-tasks
45+
[travis-image]: http://img.shields.io/travis/gulpjs/undertaker-common-tasks.svg
46+
47+
[gitter-url]: https://gitter.im/gulpjs/gulp
48+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png

0 commit comments

Comments
 (0)