Skip to content
This repository has been archived by the owner on Feb 5, 2018. It is now read-only.

Commit

Permalink
docs(API): syntax highlight the objects of config
Browse files Browse the repository at this point in the history
  • Loading branch information
stevemao committed Nov 15, 2016
1 parent 2bf37f1 commit 873a2fb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion readme.md
Expand Up @@ -36,7 +36,7 @@ Type: `promise`, `function` or `object`
This should serve as default values for other arguments of `conventionalChangelogCore` so you don't need to rewrite the same or similar config across your projects. Any value in this could be overwritten.
If this is a promise (recommended if async), it should resolve with the config.
If this is a function, it expects a node style callback with the config object.
If this is an object, it is the config object. The config object should include context, gitRawCommitsOpts, parserOpts and writerOpts.
If this is an object, it is the config object. The config object should include `context`, `gitRawCommitsOpts`, `parserOpts` and `writerOpts`.

##### pkg

Expand Down

0 comments on commit 873a2fb

Please sign in to comment.