Skip to content

Commit 9ec3983

Browse files
committed
docs: add example of working with github actions
1 parent 57d2710 commit 9ec3983

File tree

3 files changed

+23
-2
lines changed

3 files changed

+23
-2
lines changed
79.7 KB
Loading
77 KB
Loading

readme.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ESLint Rule Benchmark times individual ESLint rules, capturing ops/sec, mean and
1616

1717
It helps you catch regressions and quantify optimization gains.
1818

19-
## Why?
19+
## Key Features
2020

2121
- **Prevent performance regressions** – catch slow rules before they reach production
2222
- **Compare implementations** – find the fastest approach with side-by-side benchmarks
@@ -27,6 +27,11 @@ It helps you catch regressions and quantify optimization gains.
2727
- **Automate CI/CD checks** – post performance impact straight to pull requests
2828
- **Generate multiple report formats** – output to console, JSON or Markdown
2929

30+
## Used by
31+
32+
- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
33+
- [eslint-plugin-de-morgan](https://github.com/azat-io/eslint-plugin-de-morgan)
34+
3035
## Quick Start
3136

3237
1. Install package:
@@ -180,6 +185,22 @@ Hardware: Apple M1 Pro (10 cores, 2400 MHz), 32 GB RAM
180185

181186
ESLint Rule Benchmark automatically publishes benchmark results as comments to GitHub Pull Requests when running in GitHub Actions environment.
182187

188+
<picture>
189+
<source
190+
srcset="https://raw.githubusercontent.com/azat-io/eslint-rule-benchmark/main/assets/github-actions-example-light.webp"
191+
media="(prefers-color-scheme: light)"
192+
/>
193+
<source
194+
srcset="https://raw.githubusercontent.com/azat-io/eslint-rule-benchmark/main/assets/github-actions-example-dark.webp"
195+
media="(prefers-color-scheme: dark)"
196+
/>
197+
<img
198+
src="https://raw.githubusercontent.com/azat-io/eslint-rule-benchmark/main/assets/github-actions-example-light.webp"
199+
alt="ESLint Rule Benchmark GitHub Actions Example"
200+
width="800"
201+
/>
202+
</picture>
203+
183204
### Setup
184205

185206
ESLint Rule Benchmark automatically posts benchmark results as comments on pull requests.
@@ -218,7 +239,7 @@ jobs:
218239
219240
The tool uses Tinybench with warmup phases and outlier filtering for high accuracy.
220241
221-
### How It Works
242+
### How it works?
222243
223244
The tool uses [Tinybench](https://github.com/tinylibs/tinybench) for accurate and reliable benchmarking:
224245

0 commit comments

Comments
 (0)