docs: add ToC to benchmarks/README.md
[poolifier.git] / benchmarks / README.md
1 # Poolifier benchmarks
2
3 Welcome to poolifier benchmarks.
4
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
13 ## Folder Structure
14
15 The [internal](./internal) folder contains poolifier internal benchmark code.
16
17 ## Poolifier benchmark versus other worker pools
18
19 See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme).
20
21 ## Poolifier internal benchmark
22
23 ### Usage
24
25 To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run `pnpm benchmark`.
26
27 ### [Results](https://bencher.dev/perf/poolifier)