tidyTime.js

A jQuery plugin, that provides a more friendly way of displaying time updates to users!

tidyTime.js takes any regular time and changes it into more human friendly dialogue such as "It's just gone noon. It's quarter past 8 in the evening, it's nearly half past 4 in the afternoon, it's just gone 25 to 6" and more. By adding additional text before and after the time you are able to create powerful friendly interaction with users.

tidyTime.js works best with dynamic websites and apps and can be used as a stand alone clock. Here are some examples.

							</tr>
							<tr>
								<td><code>5:45</code></td>
								<td>becomes</td>
								<td>"Wakey wakey! It's a quarter to 6 in the morning"</td>
							</tr>	
							<tr>
								<td><code>14:29</code></td>
								<td>becomes</td>
								<td>"It's nearly half past 2"</td>
							</tr>
							<tr>
								<td><code>16:55</code></td>
								<td>becomes</td>
								<td>"You recieved this message at 5 to 5"</td>
							</tr>
							<tr>
								<td><code>16:33</code></td>
								<td>becomes</td>
								<td>"It's 27 minutes to 5. You're gonna be late!"</td>
							</tr>
							<tr>
								<td><code>20:00</code></td>
								<td>becomes</td>
								<td>"It's 8 o'clock and 3 of your friends shared this on Twitter"</td>
							</tr>
							<tr>
								<td><code>12:01</code></td>
								<td>becomes</td>
								<td>"It's just gone 12 noon. Lets create some music!"</td>
							</tr>

							<tr>
								<td><code>13:45</code></td>
								<td>becomes</td>
								<td>"This blog was posted at a quarter to 4"</td>
							</tr>

						</tbody>
					</table>

##..:: Getting Started

Include the relevant files

Firstly include jQuery and tidyTime.js files.

<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="tidyTime.js"></script>

Instantiate the plugin

Create an element such as a div or span and add a class or ID of your choice.

<span class="tidyTime"></span>

In it's most basic form tidyTime can be actioned with no options passed and will just display the current time in tidyTime format.

$(document).ready(function ($) {

   $('.tidyTime').tidyTime();	

});

If you want to instantiate the plugin with options then you can do so like:

$('.tidyTime').tidyTime({
    	time: '08:15',
		before:'It\'s ',
		after:' and I\'m feeling good!',
		periodOfDay: true,
		callback:tidyTimeFunction
	});

###Options

//HTML
<span class="tidyTime"></span>

//Jquery
var tidyTime = $('.tidyTime');
tidyTime.tidyTime({
    	before:'Hey dude! It\'s ',
		after:' and I\'m feeling good!'
	});

setInterval(function(){

	tidyTime.tidyTime({
		before:'Hey dude! It\'s ',
		after:' and I\'m feeling good!'
	});

},30000);