docs: move benchmark documentation to its repo
[poolifier.git] / benchmarks / README.md
index bdec9bf225305dea2cad104cbdf29f2cb31ff7cd..bf686a744fb5ba772f137661f2267c71b598eb69 100644 (file)
@@ -1,43 +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 folder contains poolifier internal benchmarks.  
-The 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 that 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)
-- [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)
+## 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).  
-  This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3.
+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 benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark`
-
-## 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
-
-> :warning: **Please be sure to use a quite PC when you run the benchmarks**
+### [Results](https://bencher.dev/perf/poolifier)