Skip to content

Commit

Permalink
Update docs (closes #18)
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Jun 6, 2021
1 parent 94d1619 commit ad74134
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@ Use one of:
- `angular`
- `atom`
- `codemirror`
- `conventionalcommits`
- `ember`
- `eslint`
- `express`
- `jquery`
- `jscs`
- `jshint`

Use an object with `name` and `types` to use a custom preset, such as conventional commits:
Use an object with `name` and `types` to use a custom preset:

```json
"plugins": {
Expand All @@ -62,6 +63,10 @@ Use an object with `name` and `types` to use a custom preset, such as convention
}
```

See the
[Conventional Changelog Configuration Spec (v2.1.0)](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.1.0/README.md)
for the configuration object to pass as `preset`.

### `infile`

Default value: `undefined`
Expand Down

0 comments on commit ad74134

Please sign in to comment.