# Cldr Collation
A NIF-based Unicode collator based upon the Unicode library `libicu4c`. Builds upon the
erlang library [erlang-ucol](https://github.com/barrel-db/erlang-ucol) by Benoît Chesneau <benoitc@e-engura.org>
and Nicolas Dufour <nrdufour@gmail.com>
This initial version uses only the "root" locale collator which is the [CLDR DUCET collator](http://userguide.icu-project.org/collation).
## Requirements
This module requires the package `icu4c` be installed on your system.
For OSX users, the standard installation that is delivered with MAC OS is used. No separate installation is required.
## Examples
```elixir
iex> Cldr.Collation.compare("a", "A", casing: :insensitive)
:eq
iex> Cldr.Collation.compare("a", "A", casing: :sensitive)
:lt
# Using Elixir 1.10 Enum.sort
# Cldr.Collation, Cldr.Collation.Sensitive, Cldr.Collation.Insensitive
# comparise modules are provided
iex> Enum.sort ["AAAA", "AAAa"], Cldr.Collation.Insensitive
["AAAA", "AAAa"]
iex> Enum.sort ["AAAA", "AAAa"], Cldr.Collation.Sensitive
["AAAa", "AAAA"]
```
## Installation
The package can be installed by adding `cldr_collation` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:cldr_collation, "~> 0.2.0"}
]
end
Ensure the package `icu4c` is installed on your system before invoking `mix compile` or `iex -S mix`.
```