README.md
[![Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
[![Build Status](https://travis-ci.org/pbogut/recurring_events.svg?branch=master)](https://travis-ci.org/pbogut/recurring_events)
# RecurringEvents
*RecurringEvents* is an Elixir library providing recurring events support
(duh!).
## Documentation
API documentation is available at [https://hexdocs.pm/recurring_events](https://hexdocs.pm/recurring_events)
## Installation
The package can be installed as:
1. Add `recurring_events` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:recurring_events, "~> 0.1.0"}]
end
```
2. Ensure `recurring_events` is started before your application:
```elixir
def application do
[applications: [:recurring_events]]
end
```