mirror of https://github.com/scratchfoundation/jquery-timeago.git synced 2024-11-23 07:47:54 -05:00

Timeago is a jQuery plugin that makes it easy to support automatically updating fuzzy timestamps (e.g. "4 minutes ago").

Find a file

Martin Solli efdbae1c1f Cutoff setting for leaving older dates alone. The cutoff setting, if set to something other than 0, ensures that dates older than this number of milliseconds is not touched by timeago.		2013-05-18 13:54:06 +01:00
locales	Update jquery.timeago.ar.js	2013-05-05 05:21:27 +03:00
test	Cutoff setting for leaving older dates alone.	2013-05-18 13:54:06 +01:00
vendor/cache	Updated rake tasks to automatically compile CoffeeScript	2011-09-23 16:59:49 -04:00
.gitignore	Removed public symlink	2013-02-26 10:24:53 -05:00
clock.png	first version	2008-07-18 11:34:13 -04:00
CNAME	Added GitHub Pages support	2009-07-17 13:43:44 -04:00
index.html	Bumped version to 1.0.0	2013-01-21 10:33:20 -05:00
jquery.timeago.js	Cutoff setting for leaving older dates alone.	2013-05-18 13:54:06 +01:00
LICENSE.txt	Added license file	2013-02-23 12:48:36 -05:00
Rakefile	Removed unused monitoring behavior from Rakefile	2013-03-06 09:44:42 -05:00
README.markdown	Added gittip donation link	2013-05-14 11:54:25 -04:00
timeago.jquery.json	Bumped version to 1.1.0	2013-03-06 09:46:32 -05:00

README.markdown

timeago: a jQuery plugin

Timeago is a jQuery plugin that makes it easy to support automatically updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago") from ISO 8601 formatted dates and times embedded in your HTML (à la microformats).

If you like this project, please help by donating.

Gittip: https://www.gittip.com/rmm5t/
Bitcoin: 1wzBnMjWVZfpiFMc5i2nzKT7sCBaZNfLK

Usage

First, load jQuery and the plugin:

<script src="jquery.min.js" type="text/javascript"></script>
<script src="jquery.timeago.js" type="text/javascript"></script>

Now, let's attach it to your timestamps on DOM ready - put this in the head section:

<script type="text/javascript">
   jQuery(document).ready(function() {
     $("abbr.timeago").timeago();
   });
</script>

This will turn all abbr elements with a class of timeago and an ISO 8601 timestamp in the title (conforming to the datetime design pattern microformat):

<abbr class="timeago" title="2011-12-17T09:24:17Z">December 17, 2011</abbr>

into something like this:

<abbr class="timeago" title="December 17, 2011">about 1 day ago</abbr>

HTML5 <time> elements are also supported:

<time class="timeago" datetime="2011-12-17T09:24:17Z">December 17, 2011</time>

As time passes, the timestamps will automatically update.

For more usage and examples: http://timeago.yarp.com/

For different language configurations: visit the locales directory.

Changes

Version	Notes
1.1.x	(compare) Added update function
1.0.x	(compare) locale updates; bug fixes; AMD wrapper
0.11.x	(compare) natural rounding; locale updates;
0.10.x	(compare) locale updates
0.9.x	(compare) microsecond support; bug fixes
0.8.x	(compare) `<time>` element support; bug fixes
0.7.x	(compare) locale function overrides; unit tests
...	...

Author

Ryan McGeary (@rmm5t)

Other

MIT License