Completed comprehensive readme and bumped version to 1.0.6

samrith-s · May 28, 2017 · 1d4311b · 1d4311b
1 parent 6016c62
commit 1d4311b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -46,6 +46,9 @@ relativeDate(new Date())
     valid: Boolean
 }
 ```
+
+If the date is invalid, the text returned would be "Invalid Date" and the value would be an Invalid Date object.
+
 ## Tests
 You can run tests to check for all the available outcomes, by running `npm run cover`
 
@@ -64,6 +67,8 @@ There is an `.editorconfig` to maintain indentation across editors. Feel free to
     - Option to show texts like, 'just now', 'about a minute', etc.
 
 ## Release History
+- 1.0.6 - Completed comprehensive readme
+- 1.0.5 - Added returned object structure in readme
 - 1.0.4 - Added feature roadmap
 - 1.0.3 - Changed license of NPM package to MIT
 - 1.0.2 - Completed readme

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "relative_date",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A tiny package which, when given a date, displays it with relation to the current day.",
   "main": "relative_date.js",
   "scripts": {