README.md in rails-timeago-1.0.0 vs README.md in rails-timeago-1.1.0
- old
+ new
@@ -19,34 +19,59 @@
To use bundled jQuery Timeago plugin add this require statement to your application.js file:
//=require rails-timeago
+This will also convert all matching time tags on page load.
+
## Usage
Use the timeago_tag helper like any other regular tag helper:
<%= timeago_tag Time.zone.now, :nojs => true, :limit => 10.days.ago %>
### Available options:
* nojs
- Add time ago in words as time tag content instead of absolute time. (default: false)
+ Add time ago in words as time tag content instead of absolute time.
+ (default: false)
+
* date_only
- Only print date as tag content instead of full time. (default: true)
+ Only print date as tag content instead of full time.
+ (default: true)
+
* format
- A time format for localize method used to format static time. (default: default)
+
+ A time format for localize method used to format static time.
+ (default: default)
* limit
- Set a limit for time ago tags. All dates before given limit will not be converted. (default: 4.days.ago)
+ Set a limit for time ago tags. All dates before given limit will not be converted.
+ (default: 4.days.ago)
+
* force
- Force time ago tag ignoring limit option. (default: false)
+ Force time ago tag ignoring limit option.
+ (default: false)
+
+* default
+
+ String that will be returned if time is nil.
+ (default: '-')
+
All other options will be given as options to the time tag helper.
+
+The above options can be assigned globally as defaults using
+
+ Rails::Timeago.default_options :limit => proc { 20.days.ago }, :nojs => true
+
+A global limit should always be given as a block that will be evaluated each time
+the rails timeago_tag helper is called. That avoids the limit becoming smaller the
+longer the application runs.
## License
[MIT License](http://www.opensource.org/licenses/mit-license.php)