Skip to content

Commit 08d82d4

Browse files
committed
docs: remove docs of exporting a function
1 parent 73c8944 commit 08d82d4

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var gulp = require('gulp');
1212
var repl = require('gulp-repl');
1313

1414
gulp.task('repl-start', function (cb) {
15-
gulp.repl = repl(gulp);
15+
gulp.repl = repl.start(gulp);
1616
});
1717

1818
gulp.task('repl-stop', function (cb) {
@@ -63,37 +63,39 @@ foo bar default
6363

6464
### API
6565

66-
The module exports a function that is an alias of [`start`](#gulpreplstart)
66+
The module exports a function
6767

6868
```js
69-
var gulpREPL = require('gulp-repl');
69+
var repl = require('gulp-repl');
7070
```
7171

72-
#### gulpREPL.add
72+
with the following methods
73+
74+
#### repl.add
7375

7476
```js
7577
function add(Gulp gulp)
7678
```
7779

7880
Adds the `gulp` instance tasks for the REPL and _returns_ the module again.
7981

80-
#### gulpREPL.remove
82+
#### repl.remove
8183

8284
```js
8385
function remove(Gulp gulp)
8486
```
8587

8688
Removes the `gulp` instance tasks from the REPL and _returns_ the module again.
8789

88-
#### gulpREPL.reset
90+
#### repl.reset
8991

9092
```js
9193
function reset()
9294
```
9395

9496
Removes all of the previously added instances and _returns_ the module again.
9597

96-
#### gulpREPL.get
98+
#### repl.get
9799

98100
```js
99101
function get(Gulp gulp)
@@ -106,7 +108,7 @@ _returns_
106108
- all of the stored instances if no arguments are given
107109
- metadata stored for the given `gulp` instance if was already stored
108110

109-
#### gulpREPL.start
111+
#### repl.start
110112

111113
```js
112114
function start(Gulp gulp)
@@ -127,6 +129,11 @@ $ npm install --save-dev gulp-repl
127129

128130
## Changelog
129131

132+
[v2.0.1][v2.0.1]:
133+
- docs: remove docs of exporting a function
134+
- test: small fix to use `repl.start` instead of the `module.exports`
135+
- dev: make the `module.exports` an object
136+
130137
[v2.0.0][v2.0.0]:
131138
- docs: add new api docs
132139
- test: split test into files for each api method

0 commit comments

Comments
 (0)