docs: add ToC to benchmarks/README.md

[poolifier.git] / benchmarks / README.md

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 2008e9f0e24f38c7068897a1ee6844a26039695d..273b1535f8917a68be5c86094785810b28bb6b7f 100644 (file)
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -1,41 +1,22 @@
 # Poolifier benchmarks
 
-Welcome to poolifier benchmarks and thanks to look into this project.
+Welcome to poolifier benchmarks.
 
-## Folder Structure
-
-The [internal](./internal) folder contains poolifier internal benchmark.
-
-## Poolifier benchmark versus other worker pools
-
-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 each pool does not impact each other.
-
-- External pools with which we compare the poolifier results:
+## Table of contents
 
-  - [piscina](https://github.com/piscinajs/piscina)
-  - [tinypool](https://github.com/tinylibs/tinypool)
-  - [workerpool](https://github.com/josdejong/workerpool)
-  - [worker-nodes](https://github.com/allegro/node-worker-nodes)
-  - [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool)
-  - [nanothreads](https://github.com/snuffyDev/nanothreads)
+- [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)
 
-  Those are our results:
-
-  - CPU Intensive task with 100k operations submitted to each pool: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
-
-- External pools with which we used to compare the poolifier results:
-
-  <!-- - [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool): removed because it does not support dynamic modules import or import outside the task function. The task function is expected to be self-contained, which makes it difficult to use in real world application without ugly hacks. -->
+## Folder Structure
 
-  - [worker-threads-pool](https://github.com/watson/worker-threads-pool): removed because unmaintained since more than 4 years.
-  - [threadwork](https://github.com/kevlened/threadwork): removed because unmaintained since more than 3 years.
-  - [microjob](https://github.com/wilk/microjob): removed because unmaintained since more than 5 years.
-  - [threads.js](https://github.com/andywer/threads.js): removed because not a threads pool.
+The [internal](./internal) folder contains poolifier internal benchmark code.
 
-> :warning: **We would need funds to run our benchmark more often and on Cloud VMs, please consider to sponsor this project**
+## Poolifier benchmark versus other worker pools
 
-Read the [README.md](https://github.com/poolifier/benchmark#readme) to know how to run the benchmark.
+See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme).
 
 ## Poolifier internal benchmark
 
@@ -43,4 +24,4 @@ Read the [README.md](https://github.com/poolifier/benchmark#readme) to know how
 
 To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run `pnpm benchmark`.
 
-### [Results](https://poolifier.github.io/benchmark-results/dev/bench)
+### [Results](https://bencher.dev/perf/poolifier)