Skip to main content

README.md

![test workflow](https://github.com/cogini/file_config/actions/workflows/test.yml/badge.svg)
[![Module Version](https://img.shields.io/hexpm/v/file_config.svg)](https://hex.pm/packages/file_config)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/file_config)
[![Total Download](https://img.shields.io/hexpm/dt/file_config.svg)](https://hex.pm/packages/file_config)
[![License](https://img.shields.io/hexpm/l/file_config.svg)](https://github.com/cogini/file_config/blob/master/LICENSE.md)
[![Last Updated](https://img.shields.io/github/last-commit/cogini/file_config/main)](https://github.com/cogini/file_config/commits/main)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

# file_config

This library provides a way to load configuration from a file and reload it when
it changes. The native format is the Erlang binary term format, but it also
supports CSV and can be extended to support other formats.

## Installation

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

```elixir
def deps do
  [
    {:file_config, "~> 0.7.1"}
  ]
end
```

The docs can be found at [https://hexdocs.pm/file_config](https://hexdocs.pm/file_config).