docs(core): outputUnreleased should always use with releaseCount = 0

conventional-changelog · Jun 6, 2017 · 3cbf16e · 3cbf16e
1 parent 834e68c
commit 3cbf16e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/conventional-changelog-core/readme.md b/packages/conventional-changelog-core/readme.md
@@ -106,6 +106,8 @@ Type: `boolean` Default: `true` if a different version than last release is give
 
 If this value is `true` and `context.version` equals last release then `context.version` will be changed to `'Unreleased'`.
 
+**NOTE:** You may want to combine this option with `releaseCount` set to `0` to always overwrite the whole CHANGELOG. `conventional-changelog` only outputs a CHANGELOG and doesn't read any existing one.
+
 ##### lernaPackage
 
 Specify a package in lerna-style monorepo that the CHANGELOG should be generated for.