# Ecto Phone Number

[![license](https://img.shields.io/github/license/surgeventures/ecto-phone-number.svg)](https://github.com/surgeventures/ecto-phone-number/blob/master/LICENSE.md)
[![build status](https://img.shields.io/circleci/project/github/surgeventures/ecto-phone-number/master.svg)](https://circleci.com/gh/surgeventures/surgeventures/ecto-phone-number/tree/master)
[![Hex version](https://img.shields.io/hexpm/v/ecto_phone_number.svg)](https://hex.pm/packages/ecto_phone_number)

***Phone number type with validation and formatting for Ecto***

Features:

- Express phone numbers in the code with explicit structure
- Validate and format phone numbers using Google's globally acclaimed `libphonenumber`
- Use the most up-to-date phone definition available for Elixir

## Getting Started

Add `ecto_phone_number` as a dependency to your project in `mix.exs`:

```elixir
defp deps do
  [{:ecto_phone_number, "~> x.x.x"}]
end
```

Then run `mix deps.get` to fetch it.

## Documentation

Visit documentation on [HexDocs](https://hexdocs.pm/ecto_phone_number) for a complete API reference.