# BencheeMarkdown
[![Build Status](](
[![Coverage Status](](
[![License: MIT](](

[Benchee]( formatter to output markdown. A very early beta version.

## Installation

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

def deps do
  [{:benchee_markdown, "~> 0.2", only: :dev}]

Afterwards, run `mix deps.get` to install it.

## Usage

Simply configure `Benchee.Formatters.Markdown` as one of the formatters for
`` along with the file path you want the output to go.

list = Enum.to_list(1..10_000)
map_fun = fn i -> [i, i * i] end
    "flat_map" => fn -> Enum.flat_map(list, map_fun) end,
    "map.flatten" => fn -> list |> |> List.flatten() end
  formatters: [
      file: ""
      description: """
      This benchmark compares `foobar` with the libs `foo` and `bar`.

The sample defines both the standard console formatter and the markdown
formatter, if you don't care about the console output you can just delete that

The `:description` is optional. Without a `:description` the text "Benchmark run
from 2020-03-24 14:03:11.471713Z UTC" with the actual data time will be

## Examples

Examples can been seen at
- [examples/bench/basic](examples/bench/basic).
- [examples/bench/description](examples/bench/description).
- [examples/bench/template](examples/bench/template).

Examples can be run under `examples` with
- `mix bench.basic`
- `mix bench.description`
- `mix bench.template`