diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..09561e7 --- /dev/null +++ b/README.markdown @@ -0,0 +1,41 @@ +# 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: + + + + +Now, let's attach it to your timestamps on DOM ready: + +
+      jQuery(document).ready(function() {
+        jQuery('abbr[class*=timeago]').timeago();
+      });
+    
+ +This will turn all abbr elements with a class of timeago and an ISO 8601 timestamp in the title: + + July 17, 2008 + +into something like this: + + about 1 day ago + +As time passes, the timestamps will automatically update. + +For more usage and examples, visit: http://timeago.yarp.com/ + +## License + +Licensed under the MIT: +http://www.opensource.org/licenses/mit-license.php + +## License + +Copyright (c) 2008, Ryan McGeary (ryanonjavascript -[at]- mcgeary [*dot*] org) diff --git a/README.textile b/README.textile deleted file mode 100644 index e69de29..0000000