Fix GitHub actions issues on tests with windows and stable node

[poolifier.git] / benchmarks / README.md

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 907d8649075444943d775798920034e00eecc95e..92357060579a0c554e2ea090244aa9b612a3a546 100644 (file)
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -4,19 +4,28 @@ Welcome to poolifier benchmarks and thanks to look into this project.
 
 ## Folder Structure
 
-The internal folder contains poolifier internal benchmarks.
+The internal folder contains poolifier internal benchmarks.  
 The 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.
+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.  
+External pools with which we compared the poolifier results:
 
-We will add more details on each function that we benchmark.
+- [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/)
+- [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) -->
 
 Those are our results:
 
-- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.MD](./versus-external-pools/BENCH-100000.MD)
+- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.md](./versus-external-pools/BENCH-100000.md).
+
+> :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
 
@@ -26,7 +35,4 @@ To run the internal benchmark you just need to navigate to the root of poolifier
 
 ## Versus other pools
 
-To run the benchmark versus other pools you will need to:
-
-- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation)
-- Run the `./bench.sh` into the `versus-external-pools` folder
+Read [README.md](./versus-external-pools/README.md)