docs(README): this will mutate arguments

conventional-changelog-archived-repos · Dec 26, 2015 · 84b4aac · 84b4aac
1 parent 0b664c7
commit 84b4aac
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -184,6 +184,8 @@ This module has options `append` and `releaseCount`. However, it doesn't read yo
 
 So, when you build a parent module, you need to read the old logs and append or prepend to them based on `options.append`. However, if `options.releaseCount` is `0` you need to ignore any previous logs.
 
+Arguments passed to `conventionalChangelog` will be mutated.
+
 
 ## License