[erplerf] switch to exdoc documentation provider

Deduplicates README.md and overview.edoc.
max-au · May 24, 2022 · 45852d9 · 45852d9
1 parent 6b14224
commit 45852d9
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 425 deletions.
diff --git a/.github/workflows/erlang.yml b/.github/workflows/erlang.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        otp_version: ['23', '24']
+        otp_version: ['23', '24', '25'']
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v2

diff --git a/CHANGELOG → CHANGELOG.md b/CHANGELOG → CHANGELOG.md
diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
-erlperf
-=====
+# erlperf
+
+[![Build Status](https://github.com/max-au/erlperf/actions/workflows/erlang.yml/badge.svg?branch=master)](https://github.com/max-au/erlperf/actions) [![Hex.pm](https://img.shields.io/hexpm/v/erlperf.svg)](https://hex.pm/packages/erlperf) [![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/erlperf)
 
 Erlang Performance & Benchmarking Suite.
 Simple way to say "this code is faster than that one".
 
-Build:
+Build (tested with OTP 23, 24, 25):
 
 ```bash
     $ rebar3 as prod escriptize