From b6d877c84f70d70083e0918bb55b1e6a437769ee Mon Sep 17 00:00:00 2001 From: BryanFRD Date: Sat, 31 Oct 2026 12:13:47 +0100 Subject: [PATCH] docs(readme): refresh header and badges, fix stale content Signed-off-by: BryanFRD --- .github/logo.svg | 9 +++++++++ README.md | 8 +++++--- 2 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 .github/logo.svg diff --git a/.github/logo.svg b/.github/logo.svg new file mode 100644 index 0000000..21a2bbf --- /dev/null +++ b/.github/logo.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/README.md b/README.md index 313fbfd..4d71570 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@
-# FerrFlow Benchmarks +

FerrFlow Benchmarks

**Reusable GitHub Action for FerrFlow performance benchmarks.** Runs the micro and full suites, compares against competing release tools,
and fails the PR when a regression crosses the threshold. +[![Latest release](https://img.shields.io/github/v/release/FerrLabs/Benchmarks)](https://github.com/FerrLabs/Benchmarks/releases/latest) [![CI](https://github.com/FerrLabs/Benchmarks/actions/workflows/ci.yml/badge.svg)](https://github.com/FerrLabs/Benchmarks/actions/workflows/ci.yml) [![License](https://img.shields.io/github/license/FerrLabs/Benchmarks)](LICENSE) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/FerrLabs/Benchmarks/badge)](https://scorecard.dev/viewer/?uri=github.com/FerrLabs/Benchmarks) @@ -18,9 +19,10 @@ and fails the PR when a regression crosses the threshold. ## Usage ```yaml -- uses: FerrLabs/Benchmarks@v2 +- uses: FerrLabs/Benchmarks@v5 with: type: micro # micro, full, or all + definitions: benchmarks/fixtures/definitions ferrflow-token: ${{ secrets.FERRFLOW_TOKEN }} ``` @@ -81,7 +83,7 @@ Runs criterion benchmarks (`cargo bench`) and compares against a stored baseline ### Full (`full`) -Runs end-to-end benchmarks with [hyperfine](https://github.com/sharkdp/hyperfine) across multiple fixture sizes (single repo, mono-small, mono-medium, mono-large). Optionally compares against competitor tools (semantic-release, changesets, release-please). +Runs end-to-end benchmarks with [hyperfine](https://github.com/sharkdp/hyperfine) across multiple fixture sizes (single repo, mono-small, mono-medium, mono-large). Optionally compares against competitor tools (semantic-release, changesets, standard-version, commit-and-tag-version). release-please is measured for install size only. - Generates fixtures via the [`FerrLabs/Fixtures`](https://github.com/FerrLabs/Fixtures) action from the JSON `definitions` directory you pass - Measures execution time, memory usage, and binary size