docs: generate documentation
[poolifier.git] / benchmarks / README.md
CommitLineData
2b74d91a 1# Poolifier benchmarks
be0676b3 2
3d137f3d 3Welcome to poolifier benchmarks.
be0676b3 4
49b7175c
JB
5## Table of contents
6
7- [Folder Structure](#folder-structure)
8- [Poolifier benchmark versus other worker pools](#poolifier-benchmark-versus-other-worker-pools)
9- [Poolifier internal benchmark](#poolifier-internal-benchmark)
10 - [Usage](#usage)
11 - [Results](#results)
12
be0676b3
APA
13## Folder Structure
14
3d137f3d 15The [internal](./internal) folder contains poolifier internal benchmark code.
be0676b3 16
2b74d91a 17## Poolifier benchmark versus other worker pools
be0676b3 18
3d137f3d 19See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme).
be0676b3 20
eeabc751 21## Poolifier internal benchmark
be0676b3 22
0a9d76fc
JB
23### Usage
24
7a01f9c5 25To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run `pnpm benchmark`.
0a9d76fc 26
49d60f11 27### [Results](https://bencher.dev/perf/poolifier)