docs(API): add options.config

Fixes #6
conventional-changelog-archived-repos · Apr 9, 2016 · 29222ea · 29222ea
1 parent 58feb1a
commit 29222ea
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,14 @@ Type: `string` Possible values: `'angular'`
 
 A set of options of a popular project.
 
+##### config
+
+Type: `object`
+
+This should serve as default values for other arguments of `conventionalRecommendedBump` so you don't need to rewrite the same or similar config across your projects. Any value in this could be overwritten.
+
+**NOTE:** `options.config` will be overwritten by the values of preset. You should use either `preset` or `config`, but not both.
+
 ##### whatBump
 
 Type: `function`