docs: add expected return value details

conventional-changelog · Aug 24, 2019 · bf08d1f · bf08d1f
1 parent b27b25a
commit bf08d1f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -391,10 +391,14 @@ An `updater` is expected to be a Javascript module with _atleast_ two methods ex
 
 This method is used to read the version from the provided file contents.
 
+The return value is expected to be a semantic version string.
+
 ##### `writeVersion(contents = string, version: string): string`
 
 This method is used to write the version to the provided contents.
 
+The return value will be written directly (overwrite) to the provided file.
+
 ---
 
 Let's assume our `VERSION_TRACKER.json` has the following contents: