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

Ryan McGeary 2409c9f88d Updated donation options in readme		2014-05-19 08:55:37 -04:00
contrib	Moved knockout extension to contrib #151	2013-12-01 19:14:52 -05:00
locales	Fix jquery.timeago.tr.js	2014-05-07 11:14:18 +02:00
test	Added test for future cutoff dates	2014-05-01 14:57:04 -04: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
bower.json	Bumped version to 1.4.1	2014-05-01 14:59:05 -04: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
CONTRIBUTING.md	Added contribution guidelines	2014-02-13 15:48:03 -05:00
index.html	Added docs for "allowPast" setting.	2014-02-25 13:53:50 -05:00
jquery.timeago.js	Bumped version to 1.4.1	2014-05-01 14:59:05 -04: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	Updated donation options in readme	2014-05-19 08:55:37 -04:00
timeago.jquery.json	Bumped version to 1.4.1	2014-05-01 14:59:05 -04: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).

How You Can Help

If you like this project, please help. Donate via Gittip or buy me a coffee with Bitcoin.
You can also book a session with me on Codementor.

BTC: 1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m

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.4.x	(compare) Added allowPast setting
1.3.x	(compare) Added updateFromDOM function; bug fixes; bower support
1.2.x	(compare) Added cutoff setting
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