chore: switch from mitata to tatami-ng

[poolifier.git] / benchmarks / README.md

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 30bb4515d2ab04410ef75a7a414803bdb401046a..27467511aaee25a534213894915b3f31a89038e9 100644 (file)
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -1,33 +1,30 @@
-# Poolifier Benchmarks
+# Poolifier benchmarks
 
-Welcome to poolifier benchmarks and thanks to look into this project.
+Welcome to poolifier benchmarks.
 
-## Folder Structure
-
-The internal folder contains poolifier internal benchmarks.
-The versus-external-pools folder contains benchmarks versus other Node.js pools.
+## Table of contents
 
-## Poolifier vs other pools benchmark
+- [Folder Structure](#folder-structure)
+- [Poolifier benchmark versus other worker pools](#poolifier-benchmark-versus-other-worker-pools)
+- [Poolifier internal benchmark](#poolifier-internal-benchmark)
+  - [Usage](#usage)
+  - [Results](#results)
 
-To compare poolifier pools performance vs other pools performance we chose to use [hyperfine](https://github.com/sharkdp/hyperfine).
-We chose to use this tool because it allows to run isolated Node.js processes so that each pool does not impact each other.
-
-Those are our results:
+## Folder Structure
 
-- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.MD](./versus-external-pools/BENCH-100000.MD).  
-This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3
+The [internal](./internal) folder contains poolifier internal benchmark code.
 
-## How to run benchmarks
+## Poolifier benchmark versus other worker pools
 
-### Internal
+See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme).
 
-To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark`
+## Poolifier internal benchmark
 
-## Versus other pools
+### Usage
 
-To run the benchmark versus other pools you will need to:
+To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run:
 
-- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation)
-- Run the `./bench.sh` into the `versus-external-pools` folder
+- `pnpm benchmark:benchmark.js` or
+- `pnpm benchmark:tatami-ng`
 
-> :warning: **Please be sure to use a quite PC when you run the benchmarks**
+### [Results](https://bencher.dev/perf/poolifier)