README.md

# Repo example for Elixir

[![Hex version badge](https://img.shields.io/hexpm/v/repo_example.svg)](https://hex.pm/packages/repo_example)
[![License badge](https://img.shields.io/hexpm/l/repo_example.svg)](https://github.com/surgeventures/repo-example-elixir/blob/master/LICENSE.md)
[![Build status badge](https://img.shields.io/circleci/project/github/surgeventures/repo-example-elixir/master.svg)](https://circleci.com/gh/surgeventures/repo-example-elixir/tree/master)
[![Code coverage badge](https://img.shields.io/codecov/c/github/surgeventures/repo-example-elixir/master.svg)](https://codecov.io/gh/surgeventures/repo-example-elixir/branch/master)

**An example open source Elixir application.**

## Installation

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

```elixir
def deps do
  [
    {:repo_example, "~> x.y.z"}
  ]
end
```
## Documentation

The documentation can be found on [HexDocs](https://hexdocs.pm/repo_example).