Packages

ex_cldr_lists

0.2.2
2.12.2 2.12.1 2.12.0 2.11.1 2.11.0 2.10.2 2.10.1 2.10.0 2.9.0 2.9.0-rc.2 2.9.0-rc.1 2.9.0-rc.0 2.8.0 2.8.0-rc.0 2.7.0 2.7.0-rc.0 2.6.1 2.6.0 2.5.0 2.5.0-rc.0 2.4.0 2.3.0 2.2.2 2.2.1 2.2.0 2.1.0 2.0.2 2.0.1 2.0.0 1.2.0 1.1.0 1.0.0 1.0.0-rc.0 retired 0.3.3 retired 0.3.2 retired 0.3.1 retired 0.3.0 retired 0.2.2 retired 0.2.1 retired 0.2.0 retired 0.1.3 retired 0.1.2 retired 0.1.1 retired 0.1.0

List formatting functions for the Common Locale Data Repository (CLDR) package ex_cldr.

Retired package: Deprecated
HexDocs

Current section

Files

Jump to
Readme
44 Versions
2 Dependencies
Dependants
Files
Activity
ex_cldr_lists README.md
Raw

README.md 

# Cldr for Lists

![Build Status](http://sweatbox.noexpectations.com.au:8080/buildStatus/icon?job=cldr_lists)

![Deps Status](https://beta.hexfaktor.org/badge/all/github/kipcole9/cldr_lists.svg)

[![Hex pm](http://img.shields.io/hexpm/v/ex_cldr_lists.svg?style=flat)](https://hex.pm/packages/ex_cldr_lists)

[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/kipcole9/cldr_lists/blob/master/LICENSE)



## Introduction and Getting Started



`ex_cldr_lists` is an addon library for [ex_cldr](https://hex.pm/packages/ex_cldr) that provides localisation and formatting for lists.



The primary api is `Cldr.List.to_string/2`.  The following examples demonstrate:



```elixir

iex> Cldr.List.to_string(["a", "b", "c"], locale: "en")

{:ok, "a, b, and c"}

```



For help in `iex`:



```elixir

iex> h Cldr.List.to_string

```



## Documentation



Primary documentation is as part of the [hex documentation for ex_cldr](https://hexdocs.pm/ex_cldr/6_units_formats.html)



## Installation



Note that `:ex_cldr_lists` requires Elixir 1.5 or later.



Add `ex_cldr_dates_time` as a dependency to your `mix` project:



    defp deps do

      [

        {:ex_cldr_lists, "~> 0.2.2"}

      ]

    end



then retrieve `ex_cldr_lists` from [hex](https://hex.pm/packages/ex_cldr_lists):



    mix deps.get

    mix deps.compile