README.md in relative_time-1.0.0 vs README.md in relative_time-1.1.0
- old
+ new
@@ -1,9 +1,9 @@
# RelativeTime
-[](https://travis-ci.org/davydovanton/relative_time)
+[](https://travis-ci.org/davydovanton/relative_time) [](https://codeclimate.com/github/davydovanton/relative_time) [](https://codeclimate.com/github/davydovanton/relative_time/coverage)
-Micro lib without any dependensy for getting relative time.
+Micro lib without any dependency for getting relative time.
## Motivation
I love rails but sometimes we need to create web apps (or CLI) without rails and AS. That's why I created `#time_ago_in_words` analog on pure ruby without any dependencies.
@@ -38,11 +38,11 @@
Also you can use second argument as a from date:
```ruby
date_from = Time.now - 60 * 60 # one hour ago
-RelativeTime.in_words(Time.now, date_from) # => a hour ago
+RelativeTime.in_words(Time.now, date_from) # => an hour ago
```
### Supported intervals
* minutes
@@ -50,11 +50,28 @@
* days
* weeks
* months
* years
+### I18n
+Relative time use [i18n](https://github.com/ruby-i18n/i18n) for pluralization and translation to other languages. For using specific locale just call `#in_words` with specific locale:
+
+```ruby
+RelativeTime.in_words(Time.now, locale: :ru) # => через 3 часа
+RelativeTime.in_words(Time.now, date_from, locale: :ru) # => минуту назад
+```
+
+List of supported locales:
+
+* `en`
+* `id`
+* `ru`
+* `tr`
+* `uk`
+* `be`
+* `pt`
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/relative_time. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/davydovanton/relative_time. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-