Skip to content
This repository has been archived by the owner on Nov 21, 2017. It is now read-only.

Commit

Permalink
docs(README): notes of using with options.allBlocks is true
Browse files Browse the repository at this point in the history
  • Loading branch information
stevemao committed Jul 18, 2015
1 parent 7a80912 commit abd601c
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions readme.md
Expand Up @@ -46,6 +46,40 @@ gulp.task('default', function () {
});
```

**Note:** If your `options.allBlocks` is `true` you can just use [conventional-changelog](https://github.com/stevemao/conventional-changelog) directly or not to read the file at all.

```js
var gulp = require('gulp');
var conventionalChangelog = require('conventional-changelog');
var fs = require('fs');

gulp.task('default', function () {
return conventionalChangelog({
preset: 'angular',
allBlocks: true
})
.pipe(fs.createWriteStream('CHANGELOG'));
});

```
Or

```js
var gulp = require('gulp');
var conventionalChangelog = require('gulp-conventional-changelog');

gulp.task('default', function () {
return gulp.src('CHANGELOG.md', {
read: false
})
.pipe(conventionalChangelog({
preset: 'angular',
allBlocks: true
}))
.pipe(gulp.dest('./'));
});
```


## API

Expand Down

0 comments on commit abd601c

Please sign in to comment.