mirror of https://github.com/scratchfoundation/jquery-timeago.git synced 2024-11-23 15:57: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

Ryan McGeary c499fe9a9d Realigned whitespace		2013-03-06 09:41:52 -05:00
locales	Update locales/jquery.timeago.zh-TW.js	2013-02-06 00:10:00 +08:00
test	Upgraded test suite to qunit 1.11.0	2013-02-01 17:13:59 -05: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
Gemfile	Updated rake tasks to automatically compile CoffeeScript	2011-09-23 16:59:49 -04:00
Gemfile.lock	Updated rake tasks to automatically compile CoffeeScript	2011-09-23 16:59:49 -04:00
index.html	Bumped version to 1.0.0	2013-01-21 10:33:20 -05:00
jquery.timeago.js	Realigned whitespace	2013-03-06 09:41:52 -05:00
LICENSE.txt	Added license file	2013-02-23 12:48:36 -05:00
Rakefile	Fixed rakefile	2011-09-23 17:03:13 -04:00
README.markdown	Added basic changelog to readme	2013-02-21 22:56:31 -05:00
timeago.jquery.json	Bumped version to 1.0.2	2013-01-24 14:43:42 -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).

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.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