README.md

# CLDRex

⚠ This is still a WIP.  Many of the features are not implemented yet, but are being actively developed.

CLDRex uses Unicode's Common Locale Data Repository (CLDR) to localize text.

This project takes many hints and guidance from [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)

## Installation

  1. Add cldrex to your list of dependencies in `mix.exs`:

        def deps do
          [{:cldrex, "~> 0.0.7"}]
        end

  2. Ensure cldrex is started before your application:

        def application do
          [applications: [:cldrex]]
        end

## Support

The following data from the CLDR is supported.

| Key | Meaning           |
| --- | -------------     |
| ✅ | Supported         |
| ⚡ | In Progress       |
| ❌ | Not Yet Supported |

  - Languages Names ✅
  - Calendar
      - Months ✅
      - Days ✅
      - Quarters ❌
      - Day Periods ❌
  - Dates ⚡
  - Times ⚡
  - Numbers
      - Basic ⚡
      - Currency ❌
      - Percent ❌
      - Decimal ❌

## Usage

For now, view the documentation on [hexdocs](https://hexdocs.pm/cldrex).

## Contribute

PRs welcome.

- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it.
- Commit, do not mess with version, or history. (If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.)
- Submit a pull request.