new version with formatted time diff output

README

@@ -16,3 +16,19 @@ You can use the difference like:
 
 diff[:year], diff[:month], diff[:week]
 
+
+Formatted Time difference
+-------------------------
+
+%y - year
+%M - month
+%w - week
+%d - day
+%h - hour
+%m - minute
+%s - second
+
+By default the format is '%y, %M, %w, %d and %h:%m:%s' this will return '1 year, 2 months, 3 weeks, 4 days and 12:05:52'.
+You will get the result from the output hash, time_diff_components[:diff] 
+
+You can pass your own format as third parameter to this function.

README.rdoc

@@ -8,13 +8,28 @@ gem install time_diff
 
 require 'time_diff'
 
-diff = Time.diff(start_date_time, end_date_time)
+time_diff_components = Time.diff(start_date_time, end_date_time)
 
 This will return the hash of time difference in terms of years, month, week, day, hour, minute and second.
 
 You can use the difference like:
 
-diff[:year], diff[:month], diff[:week]
+time_diff_components[:year], time_diff_components[:month], time_diff_components[:week]
+
+==Formatted Time difference
+
+%y - year
+%M - month
+%w - week
+%d - day
+%h - hour
+%m - minute
+%s - second
+
+By default the format is '%y, %M, %w, %d and %h:%m:%s' this will return '1 year, 2 months, 3 weeks, 4 days and 12:05:52'.
+You will get the result from the output hash, time_diff_components[:diff] 
+
+You can pass your own format as third parameter to this function.
 
 == Contributing to time_diff
 

VERSION

@@ -1 +1 @@
-0.1.1
+2.0.0