angular/scripts/benchmarks/README.md
Paul Gschwendtner 9a01ac3f49 build: add documentation for running benchmarks
Adds documentation for running benchmarks.
2023-06-19 14:10:31 +02:00

462 B

Benchmarks script

This folder contains a convenience script for running benchmarks and performing comparisons. It can be run via yarn benchmarks. See command line help for possible commands.

The benchmark script is used in conjunction with the benchmark compare GitHub actions workflow, allowing organization members to initiate a benchmark comparison via a GitHub comment in a PR.

Docs

See the benchmark documentation.