README.md in to_duration-1.1.1 vs README.md in to_duration-1.2.0
- old
+ new
@@ -1,10 +1,10 @@
# to_duration
[](https://badge.fury.io/rb/to_duration) [](https://travis-ci.org/digaev/to_duration) [](https://coveralls.io/github/digaev/to_duration?branch=master)
-A Ruby gem for converting seconds into human-readable format. This gem adds instance method `#to_duration` to `Numeric`.
+A Ruby gem for converting seconds into human-readable format.
## Installation
Add this line to your application's Gemfile:
@@ -20,59 +20,72 @@
$ gem install to_duration
## Usage
+Just call `#to_duration` method on any `Numeric` instance.
+
```ruby
irb(main):001:0> 12345.to_duration
=> "3 hours, 25 minutes and 45 seconds"
irb(main):002:0> 1234567890.to_duration
=> "39 years, 1 month, 14 days, 5 hours, 31 minutes and 30 seconds"
-irb(main):003:0> 1234567890.to_duration(week: true)
+irb(main):003:0> 1234567890.to_duration(weeks: true)
=> "39 years, 1 month, 2 weeks, 5 hours, 31 minutes and 30 seconds"
+
+irb(main):004:0> 0.5.to_duration
+=> "Less than one second"
```
-## Options
+### #to_duration(options = {})
-* `year` - default `true`
-* `month` - default `true`
-* `week` - default `false`
-* `day` - default `true`
-* `hour` - default `true`
-* `minute` - default `true`
-* `second` - default `true`
+| Option | Type | Default |
+|---|:-:|:-:|
+| `:years` | Boolean | `true` |
+| `:months` | Boolean | `true` |
+| `:weeks` | Boolean | `false` |
+| `:days` | Boolean | `true` |
+| `:hours` | Boolean | `true` |
+| `:minutes` | Boolean | `true` |
+| `:seconds` | Boolean | `true` |
+**Notice:** Before version `1.2.0` these keys were singular.
+
## Localization
-In your Rails application edit `config/locales/#{locale}.yml`:
+The gem uses [I18n](https://github.com/svenfuchs/i18n) for localization.
```yml
-to_duration:
- and: and
- year:
- one: year
- other: years
- month:
- one: month
- other: months
- week:
- one: week
- other: weeks
- day:
- one: day
- other: days
- hour:
- one: hour
- other: hours
- minute:
- one: minute
- other: minutes
- second:
- one: second
- other: seconds
+en: # Replace this key with your locale
+ to_duration:
+ and: and
+ less_than_one_second: Less than one second
+ year:
+ one: year
+ other: years
+ month:
+ one: month
+ other: months
+ week:
+ one: week
+ other: weeks
+ day:
+ one: day
+ other: days
+ hour:
+ one: hour
+ other: hours
+ minute:
+ one: minute
+ other: minutes
+ second:
+ one: second
+ other: seconds
```
+
+If you're on Rails you may create `config/locales/to_duration_#{locale}.yml` file.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/digaev/to_duration.