# Cldr Collation

A NIF-based Unicode collator based upon the Unicode library `libicu4c`. Builds upon the
erlang library [erlang-ucol]( by Benoît Chesneau <>
and Nicolas Dufour <>

This initial version uses only the "root" locale collator which is the [CLDR DUCET collator](

## 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
  iex>"a", "A", casing: :insensitive)

  iex>"a", "A", casing: :sensitive)

  # 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`:

def deps do
    {:cldr_collation, "~> 0.2.0"}

Ensure the package `icu4c` is installed on your system before invoking `mix compile` or `iex -S mix`.