Merge branch 'feature/task-functions' of github.com:poolifier/poolifier into feature...
[poolifier.git] / benchmarks / README.md
index 60f84062175b2efa99f6be19f111ad434efc4b5a..f0788a4fc970aefcb85378a7350ddc6c2dcdd940 100644 (file)
@@ -4,8 +4,8 @@ Welcome to poolifier benchmarks and thanks to look into this project.
 
 ## 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.  
+The [versus-external-pools](./versus-external-pools) folder contains benchmark versus other Node.js pools.
 
 ## Poolifier vs other pools benchmark
 
@@ -32,12 +32,16 @@ We chose to use this tool because it allows to run isolated Node.js processes so
   - [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.
+  - [threads.js](https://github.com/andywer/threads.js): removed because not a threads pool.
 
-> :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project**
+> :warning: **We would need funds to run our benchmark more often and on Cloud VMs, please consider to sponsor this project**
 
-Read [README.md](./versus-external-pools/README.md) to know how to run the benchmarks.
+Read the [README.md](./versus-external-pools/README.md) to know how to run the benchmark.
 
-## Internal
+## Poolifier internal benchmark
 
-To run the internal benchmarks, you just need to navigate to the root of poolifier project and run `pnpm benchmark`
+### Usage
+
+To run the internal benchmark, you just need to navigate to the root of poolifier project and run `pnpm benchmark`.
+
+### [Results](https://poolifier.github.io/benchmark-results/dev/bench)