jquery-timeago/README.markdown

54 lines
1.5 KiB
Markdown
Raw Normal View History

2008-07-18 17:12:09 -04:00
# 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:
2011-05-30 21:58:20 -04:00
```html
<script src="jquery.min.js" type="text/javascript"></script>
<script src="jquery.timeago.js" type="text/javascript"></script>
```
2008-07-18 17:12:09 -04:00
Now, let's attach it to your timestamps on DOM ready - put this in the head section:
2008-07-18 17:12:09 -04:00
2011-05-30 21:58:20 -04:00
```html
<script type="text/javascript">
2011-05-30 21:58:20 -04:00
jQuery(document).ready(function() {
$("abbr.timeago").timeago();
2011-05-30 21:58:20 -04:00
});
</script>
2011-05-30 21:59:15 -04:00
```
2008-07-18 17:12:09 -04:00
This will turn all abbr elements with a class of timeago and an ISO 8601 timestamp in the title:
2011-05-30 21:58:20 -04:00
```html
<abbr class="timeago" title="2008-07-17T09:24:17Z">July 17, 2008</abbr>
```
2008-07-18 17:12:09 -04:00
into something like this:
2011-05-30 21:58:20 -04:00
```html
<abbr class="timeago" title="July 17, 2008">about 1 day ago</abbr>
```
2008-07-18 17:12:09 -04:00
As time passes, the timestamps will automatically update.
2008-07-18 17:14:15 -04:00
**For more usage and examples**: [http://timeago.yarp.com/](http://timeago.yarp.com/)
2008-07-18 17:12:09 -04:00
-**For different language configurations**: [http://gist.github.com/6251](http://gist.github.com/6251) or just check `locales` directory.
2009-02-07 10:59:11 -05:00
## Author
[Ryan McGeary](http://ryan.mcgeary.org) ([@rmm5t](http://twitter.com/rmm5t))
2008-07-18 17:14:15 -04:00
## Other
2008-07-18 17:12:09 -04:00
2008-07-18 17:14:15 -04:00
[MIT License](http://www.opensource.org/licenses/mit-license.php)
2008-07-18 17:12:09 -04:00
2010-01-02 22:30:20 -05:00
Copyright (c) 2008-2010, Ryan McGeary (ryanonjavascript -[at]- mcgeary [*dot*] org)