Doc enhancement
[poolifier.git] / benchmarks / README.md
index 907d8649075444943d775798920034e00eecc95e..5017588e4e5ea034d7ec655c2963ce1a0ee0e98d 100644 (file)
@@ -4,19 +4,24 @@ 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)
 
 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).  
+This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3.
+
+> :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
 
@@ -30,3 +35,5 @@ 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**