README.md

# RtcDs3231

Read a DS3231 real time clock module from [Nerves](http://nerves-project.org).
Only tested on Raspberry Pi with a Sunfounder DS3231 board.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `rtc_ds3231` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:rtc_ds3231, "~> 0.1.0"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/rtc_ds3231](https://hexdocs.pm/rtc_ds3231).