twitter_cldr 3.0.0.beta1 → 3.0.0

data/README.md

@@ -1,4 +1,6 @@
-## twitter-cldr-rb [![Build Status](https://secure.travis-ci.org/twitter/twitter-cldr-rb.png?branch=master)](http://travis-ci.org/twitter/twitter-cldr-rb) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/twitter/twitter-cldr-rb)
+
+
+## twitter-cldr-rb [![Build Status](https://secure.travis-ci.org/twitter/twitter-cldr-rb.png?branch=master)](http://travis-ci.org/twitter/twitter-cldr-rb) [![Code Climate](https://codeclimate.com/github/twitter/twitter-cldr-rb.png)](https://codeclimate.com/github/twitter/twitter-cldr-rb)
 
 TwitterCldr uses Unicode's Common Locale Data Repository (CLDR) to format certain types of text into their
 localized equivalents.  Currently supported types of text include dates, times, currencies, decimals, percentages, and symbols.
@@ -18,7 +20,7 @@ require 'twitter_cldr'
 Get a list of all currently supported locales (these are all supported on twitter.com):
 
 ```ruby
-TwitterCldr.supported_locales             # [:ar, :da, :de, :en, :es, ... ]
+TwitterCldr.supported_locales             # [:af, :ar, :be, :bg, :bn, :ca, ... ]
 ```
 
 Determine if a locale is supported by TwitterCLDR:
@@ -37,18 +39,18 @@ TwitterCldr patches core Ruby objects like `Fixnum` and `Date` to make localizat
 
 ```ruby
 # default formatting with to_s
-1337.localize(:es).to_s                                    # 1.337
+1337.localize(:es).to_s                                    # "1 337"
 
 # currencies, default USD
-1337.localize(:es).to_currency.to_s                        # 1.337,00 $
-1337.localize(:es).to_currency.to_s(:currency => "EUR")    # 1.337,00 €
+1337.localize(:es).to_currency.to_s                        # "1 337,00 $"
+1337.localize(:es).to_currency.to_s(:currency => "EUR")    # "1 337,00 €"
 
 # percentages
-1337.localize(:es).to_percent.to_s                         # 1.337%
-1337.localize(:es).to_percent.to_s(:precision => 2)        # 1.337,00%
+1337.localize(:es).to_percent.to_s                         # "1 337%"
+1337.localize(:es).to_percent.to_s(:precision => 2)        # "1 337,00%"
 
 # decimals
-1337.localize(:es).to_decimal.to_s(:precision => 3)        # 1.337,000
+1337.localize(:es).to_decimal.to_s(:precision => 3)        # "1 337,000"
 ```
 
 **Note**: The `:precision` option can be used with all these number formatters.
@@ -60,16 +62,18 @@ num = TwitterCldr::Localized::LocalizedNumber.new(1337, :es)
 num.to_currency.to_s  # ...etc
 ```
 
+
+
 #### More on Currencies
 
 If you're looking for a list of supported currencies, use the `TwitterCldr::Shared::Currencies` class:
 
 ```ruby
 # all supported currency codes
-TwitterCldr::Shared::Currencies.currency_codes             # ["LTL", "PHP" ... ]
+TwitterCldr::Shared::Currencies.currency_codes             # ["ADP", "AED", "AFA", "AFN", ... ]
 
 # data for a specific currency code
-TwitterCldr::Shared::Currencies.for_code("CAD")            # { :currency => "Canadian dollar", :symbol => "$", :code_points => [36], :cldr_symbol => "CA$", :country => "Canada" }
+TwitterCldr::Shared::Currencies.for_code("CAD")            # {:currency=>:CAD, :name=>"Canadian dollar", :cldr_symbol=>"CA$", :symbol=>"$", :code_points=>[36]}
 ```
 
 #### Short / Long Decimals
@@ -77,11 +81,70 @@ TwitterCldr::Shared::Currencies.for_code("CAD")            # { :currency => "Can
 In addition to formatting regular decimals, TwitterCLDR supports short and long decimals.  Short decimals abbreviate the notation for the appropriate power of ten, for example "1M" for 1,000,000 or "2K" for 2,000.  Long decimals include the full notation, for example "1 million" or "2 thousand".  Long and short decimals can be generated using the appropriate `to_` method:
 
 ```ruby
-2337.localize.to_short_decimal.to_s     # 2K
-1337123.localize.to_short_decimal.to_s  # 1M
+2337.localize.to_short_decimal.to_s     # "2K"
+1337123.localize.to_short_decimal.to_s  # "1M"
+
+2337.localize.to_long_decimal.to_s      # "2 thousand"
+1337123.localize.to_long_decimal.to_s   # "1 million"
+```
+
+### Number Spellout, Ordinalization, and More
+
+TwitterCLDR's rule-based number formatters are capable of transforming integers into their written equivalents. Note that rule-based formatting of decimal numbers is currently not supported for languages other than English.
+
+#### Spellout
+
+For easy spellout formatting, check out the `LocalizedNumber#spellout` method:
+
+```ruby
+123.localize.spellout     # one hundred twenty-three
+25_641.localize.spellout  # twenty-five thousand six hundred forty-one
+```
+
+As always, you can call `#localize` with a locale symbol:
+
+```ruby
+123.localize(:es).spellout     # ciento veintitrés
+25_641.localize(:ru).spellout  # двадцать пять тысяч шестьсот сорок один
+```
+
+#### Ordinalization and More
+
+The available rule-based number formats defined by the CLDR data set vary by language. Some languages support ordinal and cardinal numbers, occasionally with an additional masculine/feminine option, while others do not. You'll need to consult the list of available formats for your language.
+
+Rule-based number formats are categorized by groups, and within groups by rulesets. You'll need to specify both to make use of all the available formats for your language.
 
-2337.localize.to_long_decimal.to_s      # 2 thousand
-1337123.localize.to_long_decimal.to_s   # 1 million
+To get a list of supported groups, use the `#group_names` method:
+
+```ruby
+123.localize(:pt).rbnf.group_names  # ["SpelloutRules", "OrdinalRules"]
+```
+
+To get a list of supported rulesets for a group name, use the `#rule_set_names_for_group` method:
+
+```ruby
+# ["digits-ordinal-masculine", "digits-ordinal-feminine", "digits-ordinal"]
+123.localize(:pt).rbnf.rule_set_names_for_group("OrdinalRules")
+```
+
+Once you've chosen a group and ruleset, you can pass them to the `to_rbnf_s` method:
+
+```ruby
+123.localize(:pt).to_rbnf_s("OrdinalRules", "digits-ordinal-feminine")  # 123a
+123.localize(:pt).to_rbnf_s("OrdinalRules", "digits-ordinal-masculine") # 123o
+```
+
+For comparison, here's what English ordinal formatting looks like:
+
+```ruby
+123.localize.to_rbnf_s("OrdinalRules", "digits-ordinal")  # 123rd
+```
+
+For English (and other languages), you can also specify an ordinal spellout:
+
+```ruby
+123.localize.to_rbnf_s("SpelloutRules", "spellout-ordinal")  # one hundred twenty-third
+123.localize(:pt).to_rbnf_s("SpelloutRules", "spellout-ordinal-masculine")  # centésimo vigésimo terceiro
 ```
 
 ### Dates and Times
@@ -89,26 +152,28 @@ In addition to formatting regular decimals, TwitterCLDR supports short and long
 `Time`, and `DateTime` objects are supported.  `Date` objects are supported transiently:
 
 ```ruby
-DateTime.now.localize(:es).to_full_s               # "lunes, 12 de diciembre de 2011 21:44:57 UTC -08:00"
-DateTime.now.localize(:es).to_long_s               # "12 de diciembre de 2011 21:44:57 UTC"
-DateTime.now.localize(:es).to_medium_s             # "12/12/2011 21:44:57"
-DateTime.now.localize(:es).to_short_s              # "12/12/11 21:44"
+DateTime.now.localize(:es).to_full_s               # "viernes, 14 de febrero de 2014, 12:20:05 (UTC +00:00)"
+DateTime.now.localize(:es).to_long_s               # "14 de febrero de 2014, 12:20:05 UTC"
+DateTime.now.localize(:es).to_medium_s             # "14/2/2014 12:20:05"
+DateTime.now.localize(:es).to_short_s              # "14/2/14 12:20"
 
-Time.now.localize(:es).to_full_s                   # "21:44:57 UTC -0800"
-Time.now.localize(:es).to_long_s                   # "21:44:57 UTC"
-Time.now.localize(:es).to_medium_s                 # "21:44:57"
-Time.now.localize(:es).to_short_s                  # "21:44"
+Time.now.localize(:es).to_full_s                   # "12:20:05 (UTC +00:00)"
+Time.now.localize(:es).to_long_s                   # "12:20:05 UTC"
+Time.now.localize(:es).to_medium_s                 # "12:20:05"
+Time.now.localize(:es).to_short_s                  # "12:20"
 
-DateTime.now.localize(:es).to_date.to_full_s       # "lunes 12 de diciembre de 2011"
-DateTime.now.localize(:es).to_date.to_long_s       # "12 de diciembre de 2011"
-DateTime.now.localize(:es).to_date.to_medium_s     # "12/12/2011"
-DateTime.now.localize(:es).to_date.to_short_s      # "12/12/11"
+DateTime.now.localize(:es).to_date.to_full_s       # "viernes, 14 de febrero de 2014"
+DateTime.now.localize(:es).to_date.to_long_s       # "14 de febrero de 2014"
+DateTime.now.localize(:es).to_date.to_medium_s     # "14/2/2014"
+DateTime.now.localize(:es).to_date.to_short_s      # "14/2/14"
 ```
 
 The default CLDR data set only includes 4 date formats, full, long, medium, and short.  See below for a list of additional formats.
 
 Behind the scenes, these convenience methods are creating instances of `LocalizedDate`, `LocalizedTime`, and `LocalizedDateTime`.  You can do the same thing if you're feeling adventurous:
 
+
+
 ```ruby
 dt = TwitterCldr::Localized::LocalizedDateTime.new(DateTime.now, :es)
 dt.to_short_s  # ...etc
@@ -116,58 +181,59 @@ dt.to_short_s  # ...etc
 
 #### Additional Date Formats
 
-Besides the default date formats, CLDR supports a number of additional ones.  The list of available formats varys for each locale.  To get a full list, use the `additional_formats_for` method:
+Besides the default date formats, CLDR supports a number of additional ones.  The list of available formats varies for each locale.  To get a full list, use the `additional_formats` method:
 
 ```ruby
-# ["EEEEd", "Ed", "GGGGyMd", "H", "Hm", "Hms", "M", "MEd", "MMM", "MMMEEEEd", "MMMEd", ... ]
-TwitterCldr::Formatters::DateTimeFormatter.additional_formats_for(:ja)
+# ["EEEEd", "EHm", "EHms", "Ed", "Ehm", "Ehms", "Gy", "GyMMM", "GyMMMEEEEd", "GyMMMEd", "GyMMMd", "H", ... ]
+DateTime.now.localize(:ja).additional_formats
 ```
 
-You can use any of the returned formats as the `:format` option when creating new instances of `LocalizedDateTime` or `DateTimeFormatter`:
+You can use any of the returned formats as the argument to the `to_additional_s` method:
 
 ```ruby
-# 2011/12/12 21:44:57
-DateTime.now.localize(:ja).to_s
-
-# 12日月曜日
-DateTime.now.localize(:ja).to_s(:format => "EEEEd")
+# "14日金曜日"
+DateTime.now.localize(:ja).to_additional_s("EEEEd")
 ```
 
-It's important to know that, even though a format may not be available across locales, TwitterCLDR will do it's best to approximate if no exact match can be found.
+It's important to know that, even though any given format may not be available across locales, TwitterCLDR will do it's best to approximate if no exact match can be found.
 
 ##### List of additional date format examples for English:
 
-| Format | Output           |
-|:-------|------------------|
-| EHm    | Wed 17:05        |
-| EHms   | Wed 17:05:33     |
-| Ed     | 28 Wed           |
-| Ehm    | Wed 5:05 p.m.    |
-| Ehms   | Wed 5:05:33 p.m. |
-| Gy     | 2012 AD          |
-| H      | 17               |
-| Hm     | 17:05            |
-| Hms    | 17:05:33         |
-| M      | 11               |
-| MEd    | Wed 11/28        |
-| MMM    | Nov              |
-| MMMEd  | Wed Nov 28       |
-| MMMd   | Nov 28           |
-| Md     | 11/28            |
-| d      | 28               |
-| h      | 5 p.m.           |
-| hm     | 5:05 p.m.        |
-| hms    | 5:05:33 p.m.     |
-| ms     | 05:33            |
-| y      | 2012             |
-| yM     | 11/2012          |
-| yMEd   | Wed 11/28/2012   |
-| yMMM   | Nov 2012         |
-| yMMMEd | Wed Nov 28 2012  |
-| yMMMd  | Nov 28 2012      |
-| yMd    | 11/28/2012       |
-| yQQQ   | Q4 2012          |
-| yQQQQ  | 4th quarter 2012 |
+| Format     | Output                 |
+|:-----------|------------------------|
+| EHm        | Fri 12:20              |
+| EHms       | Fri 12:20:05           |
+| Ed         | 14 Fri                 |
+| Ehm        | Fri 12:20 PM           |
+| Ehms       | Fri 12:20:05 PM        |
+| Gy         | 2014 CE                |
+| GyMMM      | Feb 2014 CE            |
+| GyMMMEd    | Fri, Feb 14, 2014 CE   |
+| GyMMMd     | Feb 14, 2014 CE        |
+| H          | 12                     |
+| Hm         | 12:20                  |
+| Hms        | 12:20:05               |
+| M          | 2                      |
+| MEd        | Fri, 2/14              |
+| MMM        | Feb                    |
+| MMMEd      | Fri, Feb 14            |
+| MMMd       | Feb 14                 |
+| Md         | 2/14                   |
+| d          | 14                     |
+| h          | 12 PM                  |
+| hm         | 12:20 PM               |
+| hms        | 12:20:05 PM            |
+| ms         | 20:05                  |
+| y          | 2014                   |
+| yM         | 2/2014                 |
+| yMEd       | Fri, 2/14/2014         |
+| yMMM       | Feb 2014               |
+| yMMMEd     | Fri, Feb 14, 2014      |
+| yMMMd      | Feb 14, 2014           |
+| yMd        | 2/14/2014              |
+| yQQQ       | Q1 2014                |
+| yQQQQ      | 1st quarter 2014       |
+
 
 
 #### Relative Dates and Times
@@ -175,52 +241,54 @@ It's important to know that, even though a format may not be available across lo
 In addition to formatting full dates and times, TwitterCLDR supports relative time spans via several convenience methods and the `LocalizedTimespan` class.  TwitterCLDR tries to guess the best time unit (eg. days, hours, minutes, etc) based on the length of the time span.  Unless otherwise specified, TwitterCLDR will use the current date and time as the reference point for the calculation.
 
 ```ruby
-(DateTime.now - 1).localize.ago.to_s        # 1 day ago
-(DateTime.now - 0.5).localize.ago.to_s      # 12 hours ago  (i.e. half a day)
+(DateTime.now - 1).localize.ago.to_s        # "1 day ago"
+(DateTime.now - 0.5).localize.ago.to_s      # "12 hours ago"  (i.e. half a day)
 
-(DateTime.now + 1).localize.until.to_s      # In 1 day
-(DateTime.now + 0.5).localize.until.to_s    # In 12 hours
+(DateTime.now + 1).localize.until.to_s      # "In 1 day"
+(DateTime.now + 0.5).localize.until.to_s    # "In 12 hours"
 ```
 
 Specify other locales:
 
 ```ruby
-(DateTime.now - 1).localize(:de).ago.to_s        # Vor 1 Tag
-(DateTime.now + 1).localize(:de).until.to_s      # In 1 Tag
+(DateTime.now - 1).localize(:de).ago.to_s        # "Vor 1 Tag"
+(DateTime.now + 1).localize(:de).until.to_s      # "In 1 Tag"
 ```
 
 Force TwitterCLDR to use a specific time unit by including the `:unit` option:
 
 ```ruby
-(DateTime.now - 1).localize(:de).ago.to_s(:unit => :hour)        # Vor 24 Stunden
-(DateTime.now + 1).localize(:de).until.to_s(:unit => :hour)      # In 24 Stunden
+(DateTime.now - 1).localize(:de).ago.to_s(:unit => :hour)        # "Vor 24 Stunden"
+(DateTime.now + 1).localize(:de).until.to_s(:unit => :hour)      # "In 24 Stunden"
 ```
 
 Specify a different reference point for the time span calculation:
 
 ```ruby
 # 86400 = 1 day in seconds, 259200 = 3 days in seconds
-(Time.now + 86400).localize(:de).ago(:base_time => (Time.now + 259200)).to_s(:unit => :hour)  # Vor 48 Stunden
+(Time.now + 86400).localize(:de).ago(:base_time => (Time.now + 259200)).to_s(:unit => :hour)  # "Vor 48 Stunden"
 ```
 
 Behind the scenes, these convenience methods are creating instances of `LocalizedTimespan`, whose constructor accepts a number of seconds as the first argument.  You can do the same thing if you're feeling adventurous:
 
 ```ruby
+
 ts = TwitterCldr::Localized::LocalizedTimespan.new(86400, :locale => :de)
-ts.to_s                         # In 1 Tag
-ts.to_s(:unit => :hour)         # In 24 Stunden
+ts.to_s                         # "In 1 Tag"
+ts.to_s(:unit => :hour)         # "In 24 Stunden"
+
 
 ts = TwitterCldr::Localized::LocalizedTimespan.new(-86400, :locale => :de)
-ts.to_s                         # Vor 1 Tag
-ts.to_s(:unit => :hour)         # Vor 24 Stunden
+ts.to_s                         # "Vor 1 Tag"
+ts.to_s(:unit => :hour)         # "Vor 24 Stunden"
 ```
 
 By default, timespans are exact representations of a given unit of elapsed time.  TwitterCLDR also supports approximate timespans which round up to the nearest larger unit.  For example, "44 seconds" remains "44 seconds" while "45 seconds" becomes "1 minute".  To approximate, pass the `:approximate => true` option into `to_s`:
 
 ```ruby
-TwitterCldr::Localized::LocalizedTimespan.new(44).to_s(:approximate => true)  # In 44 seconds
-TwitterCldr::Localized::LocalizedTimespan.new(45).to_s(:approximate => true)  # In 1 minute
-TwitterCldr::Localized::LocalizedTimespan.new(52).to_s(:approximate => true)  # In 1 minute
+TwitterCldr::Localized::LocalizedTimespan.new(44).to_s(:approximate => true)  # "In 44 seconds"
+TwitterCldr::Localized::LocalizedTimespan.new(45).to_s(:approximate => true)  # "In 1 minute"
+TwitterCldr::Localized::LocalizedTimespan.new(52).to_s(:approximate => true)  # "In 1 minute"
 ```
 
 ### Lists
@@ -228,17 +296,17 @@ TwitterCldr::Localized::LocalizedTimespan.new(52).to_s(:approximate => true)  #
 TwitterCLDR supports formatting lists of strings as you might do in English by using commas, eg: "Apples, cherries, and oranges".  Use the `localize` method on an array followed by a call to `to_sentence`:
 
 ```ruby
-["apples", "cherries", "oranges"].localize.to_sentence  # "apples, cherries, and oranges"
+["apples", "cherries", "oranges"].localize.to_sentence       # "apples, cherries, and oranges"
 ["apples", "cherries", "oranges"].localize(:es).to_sentence  # "apples, cherries y oranges"
 ```
 
 Behind the scenes, these convenience methods are creating instances of `ListFormatter`.  You can do the same thing if you're feeling adventurous:
 
 ```ruby
-f = TwitterCldr::Formatters::ListFormatter.new(:locale => :en)
+f = TwitterCldr::Formatters::ListFormatter.new(:en)
 f.format(["Larry", "Curly", "Moe"])  # "Larry, Curly, and Moe"
 
-f = TwitterCldr::Formatters::ListFormatter.new(:locale => :es)
+f = TwitterCldr::Formatters::ListFormatter.new(:es)
 f.format(["Larry", "Curly", "Moe"])  # "Larry, Curly y Moe"
 ```
 
@@ -252,7 +320,7 @@ TwitterCLDR makes it easy to find the plural rules for any numeric value:
 
 ```ruby
 1.localize(:ru).plural_rule                                # :one
-2.localize(:ru).plural_rule                                # :few
+2.localize(:ru).plural_rule                                # :other
 5.localize(:ru).plural_rule                                # :many
 ```
 
@@ -260,15 +328,15 @@ Behind the scenes, these convenience methods use the `TwitterCldr::Formatters::P
 
 ```ruby
 # get all rules for the default locale
-TwitterCldr::Formatters::Plurals::Rules.all                # [:one, ... ]
+TwitterCldr::Formatters::Plurals::Rules.all                # [:one, :other]
 
 # get all rules for a specific locale
 TwitterCldr::Formatters::Plurals::Rules.all_for(:es)       # [:one, :other]
-TwitterCldr::Formatters::Plurals::Rules.all_for(:ru)       # [:one, :few, :many, :other]
+TwitterCldr::Formatters::Plurals::Rules.all_for(:ru)       # [:one, :many, :other]
 
 # get the rule for a number in a specific locale
 TwitterCldr::Formatters::Plurals::Rules.rule_for(1, :ru)   # :one
-TwitterCldr::Formatters::Plurals::Rules.rule_for(2, :ru)   # :few
+TwitterCldr::Formatters::Plurals::Rules.rule_for(2, :ru)   # :other
 ```
 
 ### Plurals
@@ -276,9 +344,13 @@ TwitterCldr::Formatters::Plurals::Rules.rule_for(2, :ru)   # :few
 In addition to providing access to plural rules, TwitterCLDR allows you to embed plurals directly in your source code:
 
 ```ruby
-replacements = { :horse_count => 3,
-                 :horses => { :one => "is 1 horse",
-                              :other => "are %{horse_count} horses" } }
+replacements = {
+  :horse_count => 3,
+  :horses => {
+    :one => "is 1 horse",
+    :other => "are %{horse_count} horses"
+  }
+}
 
 # "there are 3 horses in the barn"
 "there %{horse_count:horses} in the barn".localize % replacements
@@ -336,7 +408,7 @@ You can use the localize convenience method on language code symbols to get thei
 Behind the scenes, these convenience methods are creating instances of `LocalizedSymbol`.  You can do the same thing if you're feeling adventurous:
 
 ```ruby
-ls = LocalizedSymbol.new(:ru, :es)
+ls = TwitterCldr::Localized::LocalizedSymbol.new(:ru, :es)
 ls.as_language_code  # "ruso"
 ```
 
@@ -344,10 +416,10 @@ In addition to translating language codes, TwitterCLDR provides access to the fu
 
 ```ruby
 # get all languages for the default locale
-TwitterCldr::Shared::Languages.all                                                  # { ... :"zh-Hant" => "Traditional Chinese", :vi => "Vietnamese" ... }
+TwitterCldr::Shared::Languages.all                                                  # { ... :vi => "Vietnamese", :"zh-Hant" => "Traditional Chinese" ... }
 
 # get all languages for a specific locale
-TwitterCldr::Shared::Languages.all_for(:es)                                         # { ... :"zh-Hant" => "chino tradicional", :vi => "vietnamita" ... }
+TwitterCldr::Shared::Languages.all_for(:es)                                         # { ... :vi => "vietnamita", :"zh-Hant" => "chino tradicional" ... }
 
 # get a language by its code for the default locale
 TwitterCldr::Shared::Languages.from_code(:'zh-Hant')                                # "Traditional Chinese"
@@ -383,7 +455,7 @@ TwitterCldr::Shared::PostalCodes.valid?(:ca, "V3H 1Z7")   # true
 Get a list of supported territories by using the `#territories` method:
 
 ```ruby
-TwitterCldr::Shared::PostalCodes.territories  # [:ve, :iq, :cx, :cv, ...]
+TwitterCldr::Shared::PostalCodes.territories  # [:ad, :am, :ar, :as, :at, ... ]
 ```
 
 Just want the regex?  No problem:
@@ -413,12 +485,12 @@ TwitterCldr::Shared::PhoneCodes.code_for_territory(:dk)  # "45"
 Get a list of supported territories by using the `#territories` method:
 
 ```ruby
-TwitterCldr::Shared::PhoneCodes.territories  # [:zw, :an, :tr, :by, :mh, ...]
+TwitterCldr::Shared::PhoneCodes.territories  # [:ac, :ad, :ae, :af, :ag, ... ]
 ```
 
 ### Language Codes
 
-Over the years, different standards for language codes have accumulated.  Probably the two most popular are ISO-639 and BCP-47 and their children.  TwitterCLDR provides a way to convert between these codes systematically.
+Over the years, different standards for language codes have accumulated.  Probably the two most popular are ISO-639 and BCP-47 and their children.  TwitterCLDR provides a way to convert between these codes programmatically.
 
 ```ruby
 TwitterCldr::Shared::LanguageCodes.convert(:es, :from => :bcp_47, :to => :iso_639_2)  # :spa
@@ -441,7 +513,7 @@ TwitterCldr::Shared::LanguageCodes.standards_for_language(:Spanish)
 Get a list of supported languages:
 
 ```ruby
-TwitterCldr::Shared::LanguageCodes.languages  # [:Spanish, :German, :Norwegian, :Arabic ... ]
+TwitterCldr::Shared::LanguageCodes.languages  # [:Arabic, :German, :Norwegian, :Spanish, ... ]
 ```
 
 Determine valid standards:
@@ -472,6 +544,84 @@ TwitterCldr::Shared::LanguageCodes.to_language(:spa, :iso_639_2)  # "Spanish"
 
 **NOTE**: All of the functions in `TwitterCldr::Shared::LanguageCodes` accept both symbol and string parameters.
 
+### Unicode Regular Expressions
+
+Unicode regular expressions are an extension of the normal regular expression syntax. All of the changes are local to the regex's character class feature and provide support for multi-character strings, Unicode character escapes, set operations (unions, intersections, and differences), and character sets.
+
+#### Changes to Character Classes
+
+Here's a complete list of the operations you can do inside a Unicode regex's character class.
+
+| Regex              | Description                                                                                                         |
+|:-------------------|:--------------------------------------------------------------------------------------------------------------------|
+|`[a]`               | The set containing 'a'.                                                                                             |
+|`[a-z]`             | The set containing 'a' through 'z' and all letters in between, in Unicode order.                                    |
+|`[^a-z]`            | The set containing all characters except 'a' through 'z', that is, U+0000 through 'a'-1 and 'z'+1 through U+10FFFF. |
+|`[[pat1][pat2]]`    | The union of sets specified by pat1 and pat2.                                                                       |
+|`[[pat1]&[pat2]]`   | The intersection of sets specified by pat1 and pat2.                                                                |
+|`[[pat1]-[pat2]]`   | The [symmetric difference](http://en.wikipedia.org/wiki/Symmetric_difference) of sets specified by pat1 and pat2.   |
+|`[:Lu:] or \p{Lu}`  | The set of characters having the specified Unicode property; in this case, Unicode uppercase letters.               |
+|`[:^Lu:] or \P{Lu}` | The set of characters not having the given Unicode property.                                                        |
+
+For a description of available Unicode properties, see [Wikipedia](http://en.wikipedia.org/wiki/Unicode_character_property#General_Category) (click on "[show]").
+
+#### Using Unicode Regexes
+
+Create Unicode regular expressions via the `#compile` method:
+
+```ruby
+
+regex = TwitterCldr::Shared::UnicodeRegex.compile("[:Lu:]+")
+```
+
+Once compiled, instances of `UnicodeRegex` behave just like normal Ruby regexes and support the `#match` and `#=~` methods:
+
+```ruby
+
+regex.match("ABC")  # <MatchData "ABC">
+regex =~ "fooABC"   # 3
+```
+
+Protip: Try to avoid negation in character classes (eg. [^abc] and \P{Lu}) as it tends to negatively affect both performance when constructing regexes as well as matching.
+
+#### Support for Ruby 1.8
+
+Ruby 1.8 does not allow escaped Unicode characters in regular expressions and restricts their maximum length. TwitterCLDR's `UnicodeRegex` class supports escaped unicode characters in Ruby 1.8, but cannot offer a work-around for the length issue. For this reason, Ruby 1.8 users are required to install the oniguruma regex engine and require the oniguruma gem in their projects.
+
+To install oniguruma, run `brew install oniguruma` on MacOS, `[sudo] apt-get install libonig-dev` on Ubuntu (you may need to search for other instructions specific to your platform). Then, install the oniguruma gem via your Gemfile or on your system via `gem install oniguruma`. Once installed, `require oniguruma` somewhere in your project before making use of the `TwitterCldr::Shared::UnicodeRegex` class.
+
+### Text Segmentation
+
+TwitterCLDR currently supports text segmentation by sentence as described in the [Unicode Technical Report #29](http://www.unicode.org/reports/tr29/). The segmentation algorithm makes use of Unicode regular expressions (described above). Because of this, if you're running Ruby 1.8, you'll need to follow the instructions above to install the oniguruma regular expression engine. Segmentation by word, line, and grapheme boundaries could also be supported if someone wants them.
+
+You can break a string into sentences using the `LocalizedString#each_sentence` method:
+
+```ruby
+"The. Quick. Brown. Fox.".localize.each_sentence do |sentence|
+  puts sentence.to_s  # "The.", " Quick.", " Brown.", " Fox."
+end
+```
+
+Under the hood, text segmentation is performed by the `BreakIterator` class (name borrowed from ICU). You can use it directly if you're feeling adventurous:
+
+```ruby
+
+iterator = TwitterCldr::Shared::BreakIterator.new(:en)
+iterator.each_sentence("The. Quick. Brown. Fox.") do |sentence|
+  puts sentence  # "The.", " Quick.", " Brown.", " Fox."
+end
+```
+
+To improve segmentation accuracy, a list of special segmentation exceptions have been created by the ULI (Unicode Interoperability Technical Committee, yikes what a mouthful). They help with special cases like the abbreviations "Mr." and "Ms." where breaks should not occur. ULI rules are enabled by default, but you can disable them via the `:use_uli_exceptions` option:
+
+```ruby
+
+iterator = TwitterCldr::Shared::BreakIterator.new(:en, :use_uli_exceptions => false)
+iterator.each_sentence("I like Ms. Murphy, she's nice.") do |sentence|
+  puts sentence  # "I like Ms.", " Murphy, she's nice."
+end
+```
+
 ### Unicode Data
 
 TwitterCLDR provides ways to retrieve individual code points as well as normalize and decompose Unicode text.
@@ -479,6 +629,7 @@ TwitterCLDR provides ways to retrieve individual code points as well as normaliz
 Retrieve data for code points:
 
 ```ruby
+
 code_point = TwitterCldr::Shared::CodePoint.find(0x1F3E9)
 code_point.name             # "LOVE HOTEL"
 code_point.bidi_mirrored    # "N"
@@ -489,7 +640,7 @@ code_point.combining_class  # "0"
 Convert characters to code points:
 
 ```ruby
-TwitterCldr::Utils::CodePoints.from_string("¿")  # [0xBF]
+TwitterCldr::Utils::CodePoints.from_string("¿")  # [191]
 ```
 
 Convert code points to characters:
@@ -498,10 +649,12 @@ Convert code points to characters:
 TwitterCldr::Utils::CodePoints.to_string([0xBF])  # "¿"
 ```
 
+#### Normalization
+
 Normalize/decompose a Unicode string (NFD, NFKD, NFC, and NFKC implementations available).  Note that the normalized string will almost always look the same as the original string because most character display systems automatically combine decomposed characters.
 
 ```ruby
-TwitterCldr::Normalization::NFD.normalize("français")  # "français"
+TwitterCldr::Normalization.normalize("français")  # "français"
 ```
 
 Normalization is easier to see in hex:
@@ -511,7 +664,7 @@ Normalization is easier to see in hex:
 TwitterCldr::Utils::CodePoints.from_string("español")
 
 # [101, 115, 112, 97, 110, 771, 111, 108]
-TwitterCldr::Utils::CodePoints.from_string(TwitterCldr::Normalization::NFD.normalize("español"))
+TwitterCldr::Utils::CodePoints.from_string(TwitterCldr::Normalization.normalize("español"))
 ```
 
 Notice in the example above that the letter "ñ" was transformed from `241` to `110 771`, which represent the "n" and the "˜" respectively.
@@ -533,6 +686,22 @@ Specify a specific normalization algorithm via the `:using` option.  NFD, NFKD,
 "español".localize.normalize(:using => :NFKD).code_points
 ```
 
+#### Casefolding
+
+Casefolding is, generally speaking, the process of converting uppercase characters to lowercase ones so as to make text uniform and therefore easier to search. The canonical example of this is the German double "s". The "ß" character is transformed into "ss" by casefolding.
+
+```ruby
+"Hello, World".localize.casefold.to_s  # hello, world
+"Weißrussland".localize.casefold.to_s  # weissrussland
+```
+
+Turkic languages make use of the regular and dotted uppercase i characters "I" and "İ". Normal casefolding will convert a dotless uppercase "I" to a lowercase, dotted "i", which is correct in English. Turkic languages however expect the lowercase version of a dotless uppercase "I" to be a lowercase, dotless "ı". Pass the `:t` option to the `casefold` method to force Turkic treatment of "i" characters. By default, the `:t` option is set to true for Turkish and Azerbaijani:
+
+```ruby
+"Istanbul".localize.casefold(:t => true).to_s  # ıstanbul
+"Istanbul".localize(:tr).casefold.to_s         # ıstanbul
+```
+
 ### Sorting (Collation)
 
 TwitterCLDR contains an implementation of the [Unicode Collation Algorithm (UCA)](http://unicode.org/reports/tr10/) that provides language-sensitive text sorting capabilities.  Conveniently, all you have to do is use the `sort` method in combination with the familiar `localize` method.  Notice the difference between the default Ruby sort, which simply compares bytes, and the proper language-aware sort from TwitterCLDR in this German example:
@@ -545,6 +714,7 @@ TwitterCLDR contains an implementation of the [Unicode Collation Algorithm (UCA)
 Behind the scenes, these convenience methods are creating instances of `LocalizedArray`, then using the `TwitterCldr::Collation::Collator` class to sort the elements:
 
 ```ruby
+
 collator = TwitterCldr::Collation::Collator.new(:de)
 collator.sort(["Art", "Wasa", "Älg", "Ved"])      # ["Älg", "Art", "Ved", "Wasa"]
 collator.sort!(["Art", "Wasa", "Älg", "Ved"])     # ["Älg", "Art", "Ved", "Wasa"]
@@ -553,6 +723,7 @@ collator.sort!(["Art", "Wasa", "Älg", "Ved"])     # ["Älg", "Art", "Ved", "Was
 The `TwitterCldr::Collation::Collator` class also provides methods to compare two strings, get sort keys, and calculate collation elements for individual strings:
 
 ```ruby
+
 collator = TwitterCldr::Collation::Collator.new(:de)
 collator.compare("Art", "Älg")           # 1
 collator.compare("Älg", "Art")           # -1
@@ -572,6 +743,7 @@ When it comes to displaying text written in both right-to-left (RTL) and left-to
 To mitigate this problem, Unicode supports special invisible characters that force visual reordering so that mixed RTL and LTR (called "bidirectional") text renders naturally on the screen.  The Unicode Consortium has developed an algorithm (The Unicode Bidirectional Algorithm, or UBA) that intelligently inserts these control characters where appropriate.  You can make use of the UBA implementation in TwitterCLDR by creating a new instance of `TwitterCldr::Shared::Bidi` using the `from_string` static method, and manipulating it like so:
 
 ```ruby
+
 bidi = TwitterCldr::Shared::Bidi.from_string("hello نزوة world", :direction => :RTL)
 bidi.reorder_visually!
 bidi.to_s
@@ -586,17 +758,17 @@ Ruby 1.8 does not come with great Unicode support, and nowhere is this more appa
 You can make use of TwitterCLDR's YAML dumper by calling `localize` and then `to_yaml` on an `Array`, `Hash`, or `String`:
 
 ```ruby
-{ :hello => "world" }.localize.to_yaml
-["hello", "world"].localize.to_yaml
-"hello, world".localize.to_yaml
+{ :hello => "world" }.localize.to_yaml 
+["hello", "world"].localize.to_yaml 
+"hello, world".localize.to_yaml 
 ```
 
 Behind the scenes, these convenience methods are using the `TwitterCldr::Shared::YAML` class.  You can do the same thing if you're feeling adventurous:
 
 ```ruby
-TwitterCldr::Shared::YAML.dump({ :hello => "world" })
-TwitterCldr::Shared::YAML.dump(["hello", "world"])
-TwitterCldr::Shared::YAML.dump("hello, world")
+TwitterCldr::Shared::YAML.dump({ :hello => "world" }) 
+TwitterCldr::Shared::YAML.dump(["hello", "world"]) 
+TwitterCldr::Shared::YAML.dump("hello, world") 
 ```
 
 ## About Twitter-specific Locales
@@ -606,8 +778,8 @@ Twitter tries to always use BCP-47 language codes.  Data from the CLDR doesn't a
 ```ruby
 TwitterCldr.convert_locale(:'zh-cn')          # :zh
 TwitterCldr.convert_locale(:zh)               # :zh
-TwitterCldr.convert_locale(:'zh-tw')          # :'zh-Hant'
-TwitterCldr.convert_locale(:'zh-Hant')        # :'zh-Hant'
+TwitterCldr.convert_locale(:'zh-tw')          # :"zh-Hant"
+TwitterCldr.convert_locale(:'zh-Hant')        # :"zh-Hant"
 
 TwitterCldr.convert_locale(:msa)              # :ms
 TwitterCldr.convert_locale(:ms)               # :ms
@@ -621,7 +793,19 @@ TwitterCldr.get_locale    # will return :en
 require 'fast_gettext'
 FastGettext.locale = "ru"
 
-TwitterCldr.get_locale    # will return :ru
+TwitterCldr.locale    # will return :ru
+```
+
+## Compatibility
+
+TwitterCLDR is fully compatible with Ruby 1.8.7, 1.9.3, 2.0.0, and, experimentally, 2.1.0. We are considering dropping support for Ruby 1.8. If you still need to use TwitterCLDR in a Ruby 1.8 environment, please let us know as soon as possible. Please note that certain TwitterCLDR features require additional dependencies or considerations when run on Ruby 1.8. Refer to the sections above for details.
+
+#### Notes on Ruby 1.8
+
+Numerous TwitterCLDR features have been built with the assumption that they will only ever be used on UTF-8 encoded text, which is mostly due to the need to support Ruby 1.8. For this reason, you may find it necessary to set the global `$KCODE` variable to `"UTF-8"`. Setting this variable tells Ruby what encoding to use when loading source files. TwitterCLDR will **not** set this value for you.
+
+```ruby
+$KCODE = "UTF-8"
 ```
 
 ## Requirements
@@ -655,6 +839,6 @@ TwitterCLDR currently supports localization of certain textual objects in JavaSc
 
 ## License
 
-Copyright 2012 Twitter, Inc.
+Copyright 2014 Twitter, Inc.
 
 Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0