README.md

# Flakyci

[Flakyci](https://flakyci.com) helps you track flaky tests.

### Adding the dependency

Start adding the hex.pm dependency to your mix.exs file

```elixir
  defp deps do
    [ ...
        {:flakyci_ex, "~> 0.1", only: [:test]},
      ...
    ]
```

### Configuration

You should add your flakyci project key in the configuration test.exs file. The PROJECT_KEY is visible for the project page accessible from [here](https://flakyci.com/projects)

```elixir
config :flakyci_ex, project_key: "PROJECT_KEY"
```

To collect the tests results the library you have to add FlakyciEx.Formater to your test_helper.exs file.

```elixir
ExUnit.configure(formatters: [ExUnit.CLIFormatter, FlakyciEx.Formater])
...
ExUnit.start()
```


*You are good to go, push this to your CI and start monitoring your flaky tests*