r18n-core 3.1.1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01fc9db07f902211f29b89542f1b6aacb393c85efa4ef48e0750b24b9dbbc94e
-  data.tar.gz: cf6c8d62cb4d1447bfd9b0f34fb78dde6e35ebe7ed71e3e7fb94132bb0593278
+  metadata.gz: ef8fd883bdb307b7895551a01d0d9abe1b8cf39d78f26d8d45289245b98d7cb4
+  data.tar.gz: 2964f46777aa5b30c6fcdb964acfb94c4d4c5e3d8c0a0ddfe878569487c84fa5
 SHA512:
-  metadata.gz: de9b44856131d6d52daa7348033a6af6285bfe740f0a064ba24540071a2798a0d025976458112e6465d2386e2bfa61f5a11e40038dee4fcb77778a6103923ce0
-  data.tar.gz: 7be0bf1ccf786dd09132779852cc86bcc4d5b620ce5de7d78640a04c87e33737a0a0cb98fc5e2b85faaa2e603d5592328446d8960ef32404332109561446614e
+  metadata.gz: 376737013d9e16b9873140a971df8456c76df92e60b69b610bd339a8c1e2df955dd412eee46a34e35b89e89508e6811bac6d252dcc85077972d0fa561bf97c5f
+  data.tar.gz: dc72f088623675f0dacdf2a8f6fd4987616605142b514b48ce2a00a2d29f2073230efb96b60bab30164175d30eef3d40ccc467fb1281d4f24a856f4dc5d16089

data/ChangeLog.md

@@ -0,0 +1,398 @@
+# Change Log
+
+## Unreleased
+
+## 5.0.1 (2021-03-04)
+
+## 5.0.0 (Warszawa) (2021-03-04)
+
+* Take out `r18n-core` gem from mono-repository.
+* Set `I18n#locale` with region by its parent equal to received locale.
+  For example, if project has `en-US` and `de-DE` locales,
+  and `Accept-Language` HTTP header contains only `de` — set `de-DE` as locale.
+* Add locales with regions as sublocales of each other.
+  And load them all, not only for the first! Recursively, I guess.
+* Don't use `en` as default sublocale, it's strange.
+* Remove block setters.
+  I don't know why (for what) they were here, they were introduced without any description.
+  I see no profit from such approach. Use regular `set` or justify the necessity, please.
+* Rename `UnpluralizetedTranslation` to `UnpluralizedTranslation` (more correct spelling).
+* Remake `i18n` and `now` arguments to keyword arguments for `localize` and `format_*` methods.
+* Allow Hashes with blocks for `named_variables` filter.
+  It forces Symbol keys, but it does not break specs and it's more flexible.
+* Fix custom `format_*` methods for classes with namespaces.
+* Drop Ruby 2.4 support.
+* Support Ruby 3.
+* Avoid Ruby 4 in gem specs.
+* Add metadata to gem specs.
+* Add Alexander Popov as a gem author.
+* Run specs in random order, fix phantom fails.
+* Replace `rake` with `toys`.
+* Add Codecov and SimpleCov.
+* Update RuboCop, its configuration, and resolve new offenses.
+* Fix many Ruby warnings.
+* Add badges into README.
+
+## 4.0.0 (Santiago)
+
+* Drop Ruby 2.3 support (by Alexander Popov).
+* Drop `R18n::Utils.hash_map` (by Alexander Popov).
+* Add Ruby 2.6 and 2.7 for CI (by Alexander Popov).
+* Allow to add custom (per-project) locales (by Alexander Popov).
+* Add block for `R18n.change` (change affects only code inside block)
+  (by Alexander Popov).
+* Add `language` and `region` readers for `Locale` (by Alexander Popov).
+* Allow upcased region in translation file names (like `en-US.yml`)
+  (by Alexander Popov).
+* Load `base` translations from parent locale (by Alexander Popov).
+* Downcase locales with regions for `Translated`, like `name_en_us`
+  instead of `name_en-US` (by Alexander Popov).
+* Add Spanish Chile (`es-CL`) (by Juan Gil Miqueo).
+* Add `:with_seconds` option for Time formatting (by Alexander Popov).
+* Replace custom `gsub` in `R18n::Utils.escape_html` with `CGI.escapeHTML`
+  (by Alexander Popov).
+* Improve Indonesian translation (by Mohammad Satrio).
+* Improve documentation (by Alexander Popov).
+* Fix issue with wildcard in `Accept-Language` header (by Alexander Popov).
+
+## 3.2.0 (Kawasaki)
+* Support `*.yaml` files (by Alexander Popov).
+* Locate processed `code` in `UnsupportedLocale`, like in `Locale` (by Alexander Popov).
+* Fix `TranslatedString#to_ary`, don't return `Untranslated` (by Alexander Popov).
+* Add Welsh language (`cy`) (by Mei Gwilym).
+* Add support for custom classes localizing (`R18n.l`) (by Alexander Popov).
+* Replace blank-padded day in date with no-padded (by Alexander Popov).
+* Fix `TranslatedString#to_hash` (by Christian Höppner and Alexander Popov).
+
+## 3.1.2 (i)
+* Call `Translation#itself` as translation key instead of `Kernel#itself` implementation (by Alexander Popov).
+
+## 3.1.1 (У)
+* Fix errors and warnings from `gem build`
+
+## 3.1 (Одинцово)
+* Move `named_variables` filter from `r18n-rails-api` to `r18n-core` (by Alexander Popov).
+* Add possibility for `R18n::Locale` to define custom formatters (by Alexander Popov).
+* Fix `R18n.set` for `r18n-desktop` (by Alexander Popov).
+
+## 3.0.5 (ب)
+* Fix Farsi locale name (by @iriman).
+
+## 3.0.4 (𐤀)
+* Fix `Translated` compatibility with `Hash` (by Alexander Popov).
+
+## 3.0.3 (〥)
+* Fix missed filters in `Untranslted` initialization (by Alexander Popov).
+
+## 3.0.2 (Ё)
+* Fix `Untranslted.to_s` (by Patrik Rak).
+
+## 3.0.1 (Brooklyn)
+* Fix `no` locale deprecation warning.
+
+## 3.0 (New York)
+* Deprecate `no` locale, use `nb` instead (by Alexander Popov).
+* Remove unsafe `!!proc` filter.
+* Reduce `eval` calls (by Alexander Popov).
+
+## 2.2 (La Habana)
+* Change date format in `en` locale to `YYYY-MM-DD` (by Alexander Popov).
+* Add `TranslatedString#as_json` for ActiveSupport compatibility (by Tim Craft).
+* Fix `TranslatedString#html_safe?` behavior (by Tim Craft).
+* Fix unsupported `LANG` environment (by Chris Poirier).
+* Fix `Locale#localize` method for `DateTime` objects (by Alexander Popov).
+
+## 2.1.8 (Ѣ)
+* Fix `true` and `false` keys support (by Alexander Popov).
+
+## 2.1.7 (Sewe)
+* Add Afrikaans locale (by Llewellyn van der Merwe).
+
+## 2.1.6 (Berlin)
+* Better `TranslatedString` → `String` converting (by Patrik Rak).
+* Add Ruby on Rails 5 support.
+
+## 2.1.5 (මාතර)
+* Fix Ruby 2.4 support (by Alexander Popov)
+
+## 2.1.4 (Bakı)
+* Add Azerbaijani locale (by Adil Aliyev).
+
+## 2.1.3 (Seoul)
+* Add Korean locale (by Patrick Cheng).
+
+## 2.1.2 (Wien)
+* Fix Ruby 2.3 support.
+
+## 2.1.1 (Barcelona)
+* Better sanity check for Accept-Language header (by Viktors Rotanovs).
+
+## 2.1 (Một)
+* Add Vietnamese locale (by Nguyễn Văn Được).
+* Add Persian locale.
+* Allow to change date/time order in locales.
+* Fix pluralization in locales without plural forms.
+* Fix Mongolian base translations.
+
+## 2.0.4 (Ikkuna)
+* Fix Windows support (by janahanEDH).
+
+## 2.0.3 (Hévíz)
+* Fix Thai locale (by Kasima Tharnpipitchai).
+
+## 2.0.2 (Budapest)
+* Fix array support in translations.
+* Fix Rails support for dialect locales.
+
+## 2.0.1 (Amsterdam)
+* Fix Dutch locale.
+
+## 2.0.0 (Москва)
+* Remove Ruby 1.8 and 1.9 support.
+* Add JRuby 9000 support.
+
+### 1.1.11 (São Paulo)
+* Allow to set Proc as `default` option in Rails I18n back-end.
+
+### 1.1.10 (十)
+* Fix Esperanto locale by Larry Gilbert.
+* Fix Chinese locale (by 刘当一).
+
+### 1.1.9 (Не знайдено)
+* Fix Rails 4.0.4 support. Prevent loop on `enforce_available_locales`.
+
+### 1.1.8 (Osam)
+* Add Croatian locale (by Dino Kovač).
+* Add Serbian latin locale (by Dino Kovač).
+
+### 1.1.7 (Tujuh)
+* Return `nil` on untranslated in models with Translated.
+* Add `transliterate` method to I18n back-end.
+* Add Indonesian locale (by Guntur Akhmad).
+
+### 1.1.6 (Vitebsk)
+* Return `TranslatedString` after global String filters.
+* Fix path in global String filters.
+
+### 1.1.5 (Hilo)
+* Fix Sinatra plugin under multi-threaded web-server (by Viktors Rotanovs).
+* Fix `BigDecimal` localizing (by François Beausoleil).
+* Add American American Spanish locale (by renemarcelo).
+
+### 1.1.4 (Bokmål)
+* Add Norwegian `no` locale as gateway to Bokmål or Nynorsk.
+* Fix Norwegian Bokmål locale code.
+* Fix Hungarian time format (Kővágó Zoltán).
+
+### 1.1.3 (Saint Petersburg)
+* Fix memory leak from cache key mismatch in Rails plugin (by silentshade).
+
+### 1.1.2 (Marshal)
+* Fix translation and untranslated marshalizing (by silentshade).
+* Allow to compare untranslated strings.
+* Fix untranslated strings output in tests.
+
+### 1.1.1 (Dunhuang)
+* Don't change YAML parser in Ruby 1.9.
+* Allow to change locale by argument in R18n Rails back-end.
+* Set also Rails I18n locale in Rails auto-detect filter.
+* Fix caching with custom filters (by Anton Onyshchenko).
+* Fix translation variables with `%1` text inside (by Taras Kunch).
+* Fix Latvian locale (by Aleksandrs Ļedovskis).
+
+### 1.1.0 (Leipzig)
+* A lot of fixes in Rails I18n compatibility (thanks for Stephan Schubert).
+* Return `Untranslted`, when user try to call another translation key on
+  already translated string.
+* Add `Translation#to_hash` to get raw translation.
+* Add `Translation#inspect` to easy debug.
+* Return translation, when pluralization filter did not get count.
+* Set R18n back-end on Rails plugin init, to use it in console.
+* Allow to use Integer in translation keys.
+
+### 1.0.1 (Phuket Town)
+* Fix translation reloading in Rails and Sinatra.
+* Use global R18n settings for Sinatra extension.
+* Allow to override desktop auto-detect by LANG environment on all platforms.
+* Add support for JRuby in 1.9 mode.
+* Rename `R18n.reset` to `R18n.reset!` and add `R18n.clear_cache!`.
+* Fix Sinatra with loaded ActiveSupport.
+* Add Mongolian locale (by Elias Klughammer).
+
+### 1.0.0 (Bangkok)
+* Add `R18n.default_places`.
+* Rails `SafeBuffer` support.
+* Allow in Rails app to put filters to `app/i18n` reload them in development.
+* Move `R18n::I18n.available_locales` to `R18n.available_locales`.
+* Rename `_keys` to `translation_keys`.
+* Use Kramdown instead of Maruku for Markdown.
+* Allow to use R18n for Rails without mailer.
+* Allow to overwrite I18n object for models.
+* Autoload R18n::Translated.
+* Set default locale to R18n on Rails start to easy use in Rails console.
+* Use env language in Rails console.
+* Mark untranslated part as red in Rails console.
+* Allow to temporary change locale by `R18n.change`.
+* Add `R18n.locale` shortcut.
+* Allow return from setter block locale code, instead of I18n object.
+* Allow to set custom filters for I18n object.
+* Add Galician locale (by Eduard Giménez).
+* Add Traditional Chinese and Simplified Chinese (by Francis Chong).
+* Fix Norsk locale (by Peter Haza).
+
+### 0.4.14 (üç)
+* Fix support for Ruby 1.9.3.
+* Added Turkish locale (by Ahmet Özkaya).
+* Fix Swedish locale (by Pär Wieslander).
+
+### 0.4.13 (Sti)
+* Fix `Pathname` to `String` error in `r18n-desktop`.
+* Add Norwegian locale (by Oddmund Strømme).
+
+### 0.4.12 (Шлях)
+* Fix `Pathname` to `String` conversion error.
+* Fix model translation for non-ActiveRecord (by Szymon Przybył).
+* Add Ukrainian locale (by Ярослав Руденок).
+
+### 0.4.11 (Nancy)
+* Support for Sinatra 1.3.
+* Fix JRuby support by Paul Walker.
+* Add R18n helpers to Rails mailer by Alexey Medvedev.
+
+### 0.4.10 (Kvantum)
+* Add R18n.set(locales, places), R18n.t and R18n.l shortcuts.
+* Convert float to number on pluralization.
+* Fix loading empty translation file.
+* Add Portuguese locale.
+* Add Dutch locale (by Sander Heilbron).
+* Add Swedish locale (by Magnus Hörberg).
+
+### 0.4.9 (Kazan)
+* Add support for Psych YAML parser (thanks for Ravil Bayramgalin).
+* Fix ActiveRecord support in Translated.
+* Fix Translated to return non-string values.
+* Fix human time localization.
+* Add Bulgarian locale (by Mitko Kostov).
+* Add Australian English locale (by Dave Sag).
+
+### 0.4.8 (En ni to)
+* Fix support for Ruby 1.9.2.
+* Fix caching issue (by Viktors Rotanovs).
+* Add Danish locale (by Hans Czajkowski Jørgensen)
+* Fix Italian locale (by Viktors Rotanovs).
+* Move untranslated filters with html highlight to `r18n-core`.
+
+### 0.4.7.1 (Kyū)
+* Fix Japanese locale in Ruby 1.9.1.
+
+### 0.4.7 (Mado)
+* Fix auto-detect locale in Windows and Ruby 1.9.1 (by Marvin Gülker).
+* Fix auto-detect locale in JRuby (by Kővágó, Zoltán).
+* Fix human time format on 60 minutes.
+* Add Hungarian locale (by Kővágó, Zoltán).
+* Add Japanese locale (by hryk).
+* Fix Polish locale (by Piotr Szotkowski).
+
+### 0.4.6 (Trinity)
+* Add support for new interpolation syntax in Rails 3.
+* Add Catalian locale (by Jordi Romero).
+* Add Finish locale (by Laura Guillén).
+* Add British locale (by JP Hastings-Spital).
+* Add Latvian locale (by Iļja Ketris).
+* Fix Spanish (by Jordi Romero), German, French, Esperanto (by Iļja Ketris) and
+  Polish locales.
+* Fix documentation (by Iļja Ketris and felix).
+* Remove RubyGems from plugins requires.
+
+### 0.4.5 (Annual)
+* Filters for several types.
+* Global HTML escaping run before Markdown and Textile formatting.
+* Fix active filters after passive filters.
+* Fix human time formatting for dates with same month days.
+
+### 0.4.4 (Frank)
+* Use before filter to lazy set I18n object in Sinatra extension.
+* Set I18n object to thread (by Simon Hafner).
+* Add to l Rails helper R18n syntax.
+* Add common helpers.
+* Clear cache in `R18n.reset`.
+* Clean up code and fix bug (by Akzhan Abdulin).
+* Add Thai locale (by Felix Hanley).
+
+### 0.4.3 (Flange)
+* Add R18n style methods to Rails controllers.
+* Fix for non-string translations in Rails I18n.
+* Use default locale from Rails I18n config.
+* Load translations recursively.
+* Add Slovak locale (by Ahmed Al Hafoudh)
+
+### 0.4.2 (EMS)
+* Fixes for Ruby 1.8.6 (by Akzhan Abdulin).
+* Add method to get translation keys.
+
+### 0.4.1 (Lazy Boole)
+* Add passive filters.
+* Receive filter position as option `Hash`.
+* Fix base translations (by Pavel Kunc).
+
+### 0.4 (D-Day)
+* Rails I18n compatibility.
+* Rewrite a lot of core code to fast and cleanup version.
+* Custom translation loaders.
+* Add reload! method to I18n.
+* Add t and l helpers to Sinatra and desktop plugins.
+* Syntax sugar for default values.
+* Named variables.
+* New locale API.
+* Change API for extension translations.
+
+### 0.3.2 (Pidgin)
+* Print path of untranslated string by filters.
+* Add Italian locale (by Guido De Rosa).
+* Fix Polish locale (by Adrian Pacała).
+* Fix American English locale (by Max Aller).
+
+### 0.3.1 (Yield)
+* Add Chinese locale (by Ilia Zayats).
+* Add Spanish locale (by Andre O Moura).
+* Add Brazilian Portuguese locale (by Andre O Moura).
+* Remove RubyGems requires.
+
+### 0.3 (Vladivostok)
+* `Translated` mixin to I18n support to model or any other class.
+* New cool time formatters.
+* Filters for translations.
+* Add filters to escape HTML, Markdown and Textile syntax.
+* Pluralization and variables is now filters and can be replaced.
+* I18n#locales now contain all detected locales, used to load translations,
+  instead of just received from user.
+* Bug-fix in locale code case.
+* Add Czech locale (by Josef Pospíšil).
+
+### 0.2.3 (Shanghai eclipse)
+* R18n will return path string if translation isn't exists.
+* Add `UnsupportedLocale` class for locale without information file.
+* Load absent locale information from default locale.
+* Add Polish locale (by Tymon Tobolski).
+
+### 0.2.2 (Clone Wars)
+* Localize numbers in pluralization.
+* Bug-fix in translation variables.
+
+### 0.2.1 (Neun)
+* Ruby 1.9 compatibility.
+* Add German locale (by Benjamin Meichsner).
+
+### 0.2 (Freedom of Language)
+* Locale class can be extended for special language (for example, Indian locale
+  may has another digits grouping).
+* Load translations from several dirs.
+* Add French locale.
+* Add Kazakh locale.
+
+### 0.1.1 (Saluto)
+* Loading I18n object without translations.
+* Add output for standalone month name.
+* Don't call procedures from translations if it isn't secure.
+* Add Esperanto locale.
+* English locale now contain UK date standards.

data/README.md

@@ -1,25 +1,35 @@
-# R18n
+# R18n Core
 
-R18n is an i18n tool to translate your Ruby application into several languages.
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/r18n/r18n-core?style=flat-square)](https://cirrus-ci.com/github/r18n/r18n-core)
+[![Codecov branch](https://img.shields.io/codecov/c/github/r18n/r18n-core/master.svg?style=flat-square)](https://codecov.io/gh/r18n/r18n-core)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/r18n/r18n-core.svg?style=flat-square)](https://codeclimate.com/github/r18n/r18n-core)
+[![Depfu](https://img.shields.io/depfu/r18n/r18n-core?style=flat-square)](https://depfu.com/repos/github/r18n/r18n-core)
+[![License](https://img.shields.io/github/license/r18n/r18n-core.svg?style=flat-square)](LICENSE)
+[![Gem](https://img.shields.io/gem/v/r18n-core.svg?style=flat-square)](https://rubygems.org/gems/r18n-core)
 
-Use `r18n-rails` or `sinatra-r18n` to localize Web applications and
-`r18n-desktop` to localize desktop application.
+[R18n](https://github.com/r18n/r18n) is an i18n tool to translate your Ruby application
+into several languages.
+
+You can use [wrapper plugins](https://github.com/r18n/r18n#wrapper-plugins)
+like `r18n-rails` or `sinatra-r18n` to localize web applications
+and `r18n-desktop` to localize desktop application.
 
 ## Features
 
 * Nice Ruby-style syntax.
 * Filters.
 * Model Translation (or any Ruby object).
-* Autodetect user locales.
+* Auto-detect user locales.
 * Flexible locales.
 * Total flexibility.
 
-See full features in [main README](https://github.com/ai/r18n/blob/master/README.md).
+See full features in [main README](https://github.com/r18n/r18n/blob/master/README.md).
 
 ## Usage
 
-To add i18n support to your app, you can use the particular plugin for your
-environment: `r18n-rails`, `sinatra-r18n` or `r18n-desktop`.
+To add i18n support to your app, we suggest you to use
+[the particular plugin](https://github.com/r18n/r18n#wrapper-plugins) for your environment,
+for example `r18n-rails`, `sinatra-r18n` or `r18n-desktop`.
 
 If you develop you own plugin or want to use only core gem, you will need to
 set default translation places and current locale:
@@ -47,34 +57,35 @@ To set locale only for current thread use `R18n.thread_set`.
 
 Translation files are in YAML format by default and have names like
 `en.yml` (English) or `en-us.yml` (USA English dialect) with
-language/country code (RFC 3066).
+language/country code (RFC 3066). Upcased region (`en-US`) and
+`.yaml` file extension are also allowed.
 
 In your translation files you can use:
 
-* Strings
+*   Strings
 
     ```yaml
     robot: This is a robot
     percent: "Percent sign (%)"
     ```
 
-* Numbers
+*   Numbers
 
     ```yaml
     number: 123
     float: 12.45
     ```
 
-* Pluralizable messages
+*   Pluralizable messages
 
     ```yaml
     robots: !!pl
       0: No robots
       1: One robot
-      n: %1 robots
+      n: '%1 robots'
     ```
 
-* Filters
+*   Filters
 
     ```yaml
     filtered: !!custom_type
@@ -96,7 +107,7 @@ t.post.add     #=> "Add post"
 t[:post][:add] #=> "Add post"
 ```
 
-If the locale isn’t found in the user’s requested locale, R18n will search for
+If the locale isn't found in the user's requested locale, R18n will search for
 it in sublocales or in another locale, which the user also can accept:
 
 ```ruby
@@ -104,7 +115,7 @@ t.not.in.english #=> "В английском нет"
 ```
 
 The translated string has a `locale` method for determining its locale (Locale
-instance or code string if locale is’t supported in R18n):
+instance or code string if locale is't supported in R18n):
 
 ```ruby
 i18n.not.in.english.locale #=> Locale ru (Русский)
@@ -128,8 +139,8 @@ t.robots(1)  #=> "One robot"
 t.robots(50) #=> "50 robots"
 ```
 
-If there isn’t a pluralization for a particular number, translation will be use
-`n`. If there isn’t a locale file for translation, it will use the English
+If there isn't a pluralization for a particular number, translation will be use
+`n`. If there isn't a locale file for translation, it will use the English
 pluralization rule (`0`, `1` and `n`).
 
 You can check if the key has a translation:
@@ -193,7 +204,7 @@ To create a filter you pass the following to `R18n::Filters.add`:
 * Optional filter name, to disable, enable or delete it later by
   `R18n::Filters.off`, `R18n::Filters.on` and
   `R18n::Filters.delete`.
-* Hash with options:
+* `Hash` with options:
   * `passive: true` to filter translations only on load;
   * `:position` within the list of current filters of this type
     (by default a new filter will be inserted into last position).
@@ -201,7 +212,7 @@ To create a filter you pass the following to `R18n::Filters.add`:
 The filter will receive at least two arguments:
 * Translation (possibly already filtered by other filters for this type earlier
   in the list).
-* A Hash with translation `locale` and `path`.
+* A `Hash` with translation `locale` and `path`.
 * Parameters from translation request will be in the remaining arguments.
 
 In Rails application put your filters to `app/i18n/filters.rb`, it will be
@@ -254,7 +265,7 @@ hi: !!markdown
 t.hi #=> "<p><strong>Hi</strong>, people!</p>"
 ```
 
-If you can’t use Kramdown you can redefine Markdown filter
+If you can't use Kramdown you can redefine Markdown filter
 to use your own parser:
 
 ```ruby
@@ -270,7 +281,7 @@ end
 
 #### Textile
 
-To use Textile in your translations you must install the RedCloth gem:
+To use Textile in your translations you must install the `RedCloth` gem:
 
 ```yaml
 alarm: !!textile
@@ -311,8 +322,8 @@ l -12000.5 #=> "−12,000.5"
 Number and float formatters will also put real typographic minus and put
 non-breakable thin spaces (for locale, which use it as digit separator).
 
-You can translate months and week day names in Time, Date and DateTime by the
-`strftime` method:
+You can translate months and week day names in `Time`, `Date` and `DateTime`
+by the `strftime` method:
 
 ```ruby
 l Time.now, '%B'  #=> "September"
@@ -330,8 +341,8 @@ l Time.now.to_date #=> "2009-08-09"
 
 ### Model
 
-You can add i18n support to any classes, including ORM models (ActiveRecord,
-DataMapper, MongoMapper, Mongoid or others):
+You can add i18n support to any classes, including ORM models (`ActiveRecord`,
+`Sequel`, `DataMapper`, `MongoMapper`, `Mongoid` or others):
 
 ```ruby
 class Product
@@ -361,9 +372,9 @@ See `R18n::Translated` for documentation.
 
 ### Locale
 
-All supported locales are stored in R18n gem in `locales` directory. If you want
-to add your locale, please fork this project and send a pull request or email me
-at <andrey@sitnik.ru>.
+All supported locales are stored in `r18n-core` gem in `locales/` directory.
+If you want to add your locale, please see the ["Add Locale"](#add-locale)
+section.
 
 To get information about a locale create an `R18n::Locale` instance:
 
@@ -373,20 +384,20 @@ locale = R18n.locale('en')
 
 You can then get the following from the locale:
 
-* Locale title and RFC 3066 code:
+*   Locale title and RFC 3066 code:
 
     ```ruby
     locale.title #=> "English"
     locale.code  #=> "en"
     ```
 
-* Language direction (left to right, or right to left for Arabic and Hebrew):
+*   Language direction (left to right, or right to left for Arabic and Hebrew):
 
     ```ruby
     locale.ltr? #=> true
     ```
 
-* Week start day (`:monday` or `:sunday`):
+*   Week start day (`:monday` or `:sunday`):
 
     ```ruby
     locale.week_start #=> :sunday
@@ -398,7 +409,7 @@ You can load translations from anywhere, not just from YAML files. To load
 translation you must create loader class with 2 methods:
 
 * `available` – return array of locales of available translations;
-* `load(locale)` – return Hash of translation.
+* `load(locale)` – return `Hash` of translation.
 
 Pass its instance to `R18n.default_places` or `R18n.set(locales, loaders)`
 
@@ -448,32 +459,37 @@ R18n.extension_places << R18n::Loader::YAML.new('./error_messages/')
 
 ## Add Locale
 
-If R18n hasn’t got locale file for your language, please add it. It’s very
+If R18n has not got locale file for your language, please add it. It's very
 simple:
 
-* Create the file <tt><i>code</i>.rb</tt> in the `locales/` directory for your
-  language and describe locale. Just copy from another locale and change the
+* Create the file `%{code}.rb` for your language and describe locale, then
+  require it in the project. Just copy from another locale and change the
   values.
   * If your country has alternate languages (for example, in exUSSR countries
     most people also know Russian), add
-    <tt>sublocales %w[<i>another_locale</i> en]</tt>.
-* Create in `base/` file <tt><i>code</i>.yml</tt>  for your language and
-  translate the base messages. Just copy file from language, which you know,
-  and rewrite values.
+    `sublocales %w[%{another_locale} en]`.
 * If your language needs some special logic (for example, different
   pluralization or time formatters) you can extend `R18n::Locale` class methods.
-* Send a pull request via GitHub <http://github.com/ai/r18n> or just write email
-  with the files to me <andrey@sitnik.ru>.
 
-*Code* is RFC 3066 code for your language (for example, “en” for English and
-“fr-CA” for Canadian French). Email me with any questions you may have, you will
-find other contact addresses at http://sitnik.ru.
+If you want to send a pull request:
+
+* Move your `%{code}.rb` file in the `locales/` directory.
+* Create `%{code}.yml` file for your language in the `base/` directory and
+  translate the base messages. Just copy file from language, which you know,
+  and rewrite values.
+* Send a pull request via GitHub <http://github.com/r18n/r18n> or just write
+  email with the files to [Andrey Sitnik](mailto:andrey@sitnik.ru)
+  or [Alexander Popov](mailto:alex.wayfer@gmail.com).
+
+`%{code}` is RFC 3066 code for your language (for example, `en` for English and
+`fr-CA` for Canadian French). Email me with any questions you may have, you will
+find other contact addresses at [sitnik.ru](https://sitnik.ru/).
 
 ## License
 
 R18n is licensed under the GNU Lesser General Public License version 3.
-See the LICENSE file or http://www.gnu.org/licenses/lgpl.html.
+See the LICENSE file or [www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html).
 
 ## Author
 
-Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+Andrey “A.I.” Sitnik [andrey@sitnik.ru](mailto:andrey@sitnik.ru)