docs: move benchmark documentation to its repo

[poolifier.git] / benchmarks / README.md

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 2dccb61e1a6f703dac01fec1fe3c0eb62e13f6ec..bf686a744fb5ba772f137661f2267c71b598eb69 100644 (file)
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -1,39 +1,19 @@
-# Poolifier Benchmarks
+# 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 benchmarks.  
-The [versus-external-pools](./versus-external-pools) folder contains benchmarks versus other Node.js pools.
+The [internal](./internal) folder contains poolifier internal benchmark code.
 
-## Poolifier vs other pools 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 compared the poolifier results:
+See the dedicated repository [README.md](https://github.com/poolifier/benchmark#readme).
 
-- [piscina](https://github.com/piscinajs/piscina)
-- [tinypool](https://github.com/tinylibs/tinypool)
-- [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool): removed from the benchmark because does not support dynamic modules import or import outside of the worker function, which makes it pretty hard to use without tricks to make the worker function self-contained
-- [workerpool](https://github.com/josdejong/workerpool)
-- [worker-nodes](https://github.com/allegro/node-worker-nodes)
-- [threads.js](https://github.com/andywer/threads.js/)
-- [threadwork](https://github.com/kevlened/threadwork)
-- [microjob](https://github.com/wilk/microjob)
+## Poolifier internal benchmark
 
-Those are our results:
+### Usage
 
-- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.md](./versus-external-pools/BENCH-100000.md).
+To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run `pnpm benchmark`.
 
-> :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
-
-### Internal
-
-To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark`
-
-## Versus other pools
-
-Read [README.md](./versus-external-pools/README.md)
+### [Results](https://bencher.dev/perf/poolifier)