README.md
# Churn [![Build Status](https://github.com/patrykwozinski/churn/workflows/CI/badge.svg)](https://github.com/patrykwozinski/churn/actions) [![Hex pm](https://img.shields.io/hexpm/v/churn.svg?style=flat)](https://hex.pm/packages/churn)
**Help discover a good refactoring candidates using cyclomatic complexity and frequency of editing files**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `churn` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:churn, "~> 0.1"}
]
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/churn](https://hexdocs.pm/churn).