README.md

# Entropy

> **⚠️ PRE-RELEASE VERSION (0.0.1)**
> This package is currently under active development. The API is unstable and subject to change.
> Please do not use in production yet.

## Installation

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

```elixir
def deps do
  [
    {:entropy, "~> 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/entropy>.

## Configuration

To enable fault injection, you must explicitly configure the `entropy`
application.

```elixir
# config/config.exs
config :entropy,
  is_injection_enabled: false, # Safety Default
  injection_interval_ms: 5000,
  max_safe_cpu_percent: 95.0,
  immune_modules: [Phoenix.PubSub.Supervisor]
```