README.md

# EctoFields

Provides commonly used fields for Ecto projects.

## Installation

To install EctoFields:

  1. Add ecto_fields to your list of dependencies in `mix.exs` :
  ```elixir
    def deps do
      [{:ecto_fields, "~> 1.0.1"}]
    end
  ```
  2. Use the fields in your Ecto schema:
   ```elixir
    schema "user" do
      field :name, :string
      field :email, EctoFields.Email
      field :website, EctoFields.URL
      field :ip_address, EctoFields.IP
    end
   ```
## Current fields

* EctoFields.Atom
* EctoFields.Email
* EctoFields.IP (accepts both ipv4 and ipv6)
* EctoFields.IPv4
* EctoFields.IPv6
* EctoFields.PositiveInteger
* EctoFields.Slug
* EctoFields.Static
* EctoFields.URL

## Roadmap

### Likely:

* EctoFields.Duration

### Maybe:

* EctoFields.File
* EctoFields.Image