refactor: cleanup benchmarks export

[poolifier.git] / benchmarks / README.md

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 92357060579a0c554e2ea090244aa9b612a3a546..400bb152802bbfb6598afdb786df7bc9614d39b3 100644 (file)
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -4,22 +4,20 @@ Welcome to poolifier benchmarks and thanks to look into this project.
 
 ## Folder Structure
 
-The internal folder contains poolifier internal benchmarks.  
-The versus-external-pools folder contains benchmarks versus other Node.js pools.
+The [internal](./internal) folder contains poolifier internal benchmarks.  
+The [versus-external-pools](./versus-external-pools) folder contains benchmarks versus other Node.js pools.
 
 ## Poolifier vs other pools benchmark
 
 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.  
+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 compared the poolifier results:
 
 - [piscina](https://github.com/piscinajs/piscina)
-- [SUCHMOKUO/node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool)
-- [threads.js](https://github.com/andywer/threads.js/)
+- [tinypool](https://github.com/tinylibs/tinypool)
 - [workerpool](https://github.com/josdejong/workerpool)
-- [threadwork](https://github.com/kevlened/threadwork)
-- [microjob](https://github.com/wilk/microjob)
-<!-- - [worker-threads-pool](https://github.com/watson/worker-threads-pool) -->
+- [worker-nodes](https://github.com/allegro/node-worker-nodes)
+- [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool)
 
 Those are our results:
 
@@ -27,11 +25,18 @@ Those are our results:
 
 > :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project**
 
-## How to run benchmarks
+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 worker function. The worker function is expected to be self-contained, which makes it difficult to use in real world application without ugly hacks. -->
+
+- [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.
 
 ### Internal
 
-To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark`
+To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark`
 
 ## Versus other pools