Skip to content

Commit ce2314e

Browse files
committed
docs: try comments for blocks in setup, separate overloaded function definition for gulp.start
1 parent 118c619 commit ce2314e

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

docs/README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,43 @@ async composers
88

99
## setup
1010

11-
_gulp what?_ - If you don't know gulp [go here first][gulp]
11+
> gulp what?
1212
13-
_Install with [npm][npm]_ - `npm install --save-dev gulp-runtime`
13+
If you don't know gulp [go here first][gulp]
1414

15-
_Then open your favourite editor_
15+
> Install with [npm][npm]
1616
17-
Go to that `gulpfile` and change this line
17+
`npm install --save-dev gulp-runtime`
1818

19-
```js
20-
var gulp = require('gulp');
21-
```
19+
> Then open your favourite editor
2220
23-
with
21+
Go to that `gulpfile` and change this line
2422

25-
```js
26-
var gulp = require('gulp-runtime').create();
27-
```
23+
```js
24+
var gulp = require('gulp');
25+
```
2826

29-
After that just run `gulpfile` with `node` directly from the command line
27+
with
3028

31-
```sh
32-
node gulpfile.js --tasks default watch serve
33-
```
29+
```js
30+
var gulp = require('gulp-runtime').create();
31+
```
3432

35-
If no argument is given the `default` task will run instead (as gulp does).
33+
After that just run `gulpfile` with `node` directly from the command line
3634

37-
__What about the CLI?__
35+
```sh
36+
node gulpfile.js --tasks default watch serve
37+
```
3838

39-
Add an alias to your `.bashrc`, `.zshrc`
39+
If no argument is given the `default` task will run instead (as gulp does).
4040

41-
```sh
42-
rulp='node gulpfile.js'
43-
```
41+
> What about the CLI?
42+
43+
Add an alias to your `.bashrc`, `.zshrc`
44+
45+
```sh
46+
rulp='node gulpfile.js'
47+
```
4448

4549
## API
4650

@@ -93,7 +97,6 @@ For more regex madness on the [parth][parth] module.
9397

9498
```js
9599
function start(tasks...)
96-
function start(array tasks, args...)
97100
```
98101

99102
Run any number of `tasks...` given. Tasks can be either a `string`, that matches one of the tasks registered with or without its parameters, or a `function`.
@@ -113,6 +116,11 @@ gulp.task('thing', function (done){
113116

114117
gulp.start(build, 'thing');
115118
```
119+
___
120+
121+
```js
122+
function start(array tasks, args...)
123+
```
116124

117125
If the first argument is an array its taken as the tasks to run and the rest of arguments as the arguments to pass to the tasks to run.
118126

0 commit comments

Comments
 (0)