README.md

# Gjallar

**Gjallar** is a tiny set of Mix tasks that run a polite but opinionated CI pipeline for Elixir projects:

- `mix deps.get` → `mix deps.compile`
- Code format (write or check)
- Credo lint (optional / required / off)
- Tests with coverage (prefers ExCoveralls; falls back to built-in `:cover` and a coverage gate)

It aims to be a **thin orchestrator**: bring your own tools (ExCoveralls, Credo), and `gjallar` wires them together.

---

## Installation

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

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