Skip to content

Commit 30421ee

Browse files
committed
docs: small fixes
1 parent d9b2e8b commit 30421ee

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Instances](docs/README.md#multiple-instances)
1313
- [REPL with autocomplete](docs/README.md#repl-with-autocomplete)
1414
- [gulp API and some extra methods](docs/README.md#gulp-api-and-more)
15-
- [Tasks names :can with :parameters](docs/README.md#tasks-with-parameters)
15+
- [Tasks :names with :parameters](docs/README.md#tasks-with-parameters)
1616

1717
### samples
1818

@@ -89,6 +89,10 @@ styles.task('less', function (done, sources, dest) {
8989
.pipe(less(options.less))
9090
.pipe(gulp.dest(dest));
9191
});
92+
93+
styles.task('default', ['less']);
94+
95+
module.exports = styles;
9296
```
9397

9498
---
@@ -113,9 +117,7 @@ node gulpfile.js
113117

114118
which will run a REPL with the tasks defined.
115119

116-
> As long as the gulp instance specifies `repl: true`
117-
> their tasks will be added to the REPL.
118-
> See more in [gulp-repl][gulp-repl]
120+
> [See more](./docs/README.md#REPL)
119121
120122
### install
121123

@@ -142,7 +144,6 @@ But well oh well, here we are.
142144
[npm]: npmjs.com/gulp-runtime
143145
[license]: opensource.org/licenses/MIT
144146
[vinylFs]: npmjs.com/package/vinyl-fs
145-
[gulp-repl]: github.com/stringparser/gulp-repl
146147
[travis-build]: travis-ci.org/stringparser/gulp-runtime/builds
147148

148149
[badge-build]: http://img.shields.io/travis/stringparser/gulp-runtime/master.svg?style=flat-square

docs/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ async composers
88

99
## setup
1010

11-
_gulp what?_ If you don't know gulp [go here first][gulp]
11+
`gulp`? If you don't know about gulp [go here first][gulp]
1212

13-
_install the module_ `npm install --save-dev gulp-runtime`
13+
Install. `npm install --save-dev gulp-runtime`
1414

15-
_Open that `gulpfile` (or [create one][example-gulpfile]_) and change this
15+
Open that `gulpfile` or [create one][example-gulpfile]) and change this
1616

1717
```js
1818
var gulp = require('gulp');
@@ -32,7 +32,7 @@ node gulpfile.js default watch serve
3232

3333
If no arguments are given the `default` task will run instead (as gulp does).
3434

35-
- _What about the CLI?_
35+
__What about the CLI?__
3636

3737
Add an alias to your `.bashrc`/`.zshrc`
3838

@@ -72,9 +72,9 @@ function create(Object options)
7272

7373
`Gulp.create` creates a new `gulp` instance with the given `options`. These options default to:
7474

75-
- `options.log = true`, pass `false` for an instance with no logging
76-
- `options.repl = false`, by default the REPL is deactivated
77-
- `options.wait = false`, by default all tasks are run in __parallel__ set to `true` for this instance to run tasks in `series` always
75+
- `options.log = true` if `false` the instance will have no logging
76+
- `options.repl = false` the REPL is deactivated by default
77+
- `options.wait = false` tasks run in __parallel__. Set to `true` to always run tasks in `series`
7878

7979
> Is more convenient to use `create` instead of `new Gulp` but its up to you
8080

@@ -167,7 +167,7 @@ ___
167167
function start(Array tasks, args...)
168168
```
169169

170-
If the `tasks` is an array these will be the tasks to run (either `string` or `function`) and the rest of arguments are passed to the tasks that will run.
170+
If `tasks` is an array it will be taken as the tasks to run (`strings` and/or `functions`). The rest of arguments are passed down.
171171

172172
```js
173173
var gulp = require('gulp-runtime').create();

0 commit comments

Comments
 (0)