Merge pull request #1127 from poolifier/combined-prs-branch

[poolifier.git] / README.md

diff --git a/README.md b/README.md
index 0faebec4220e2a7e9208b6cd6fe8e1fa8d97401e..5ef4138540626b3bc523fbfa9e2277fedbc2d91a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -35,9 +35,9 @@ Moreover you can execute your tasks using an API designed to improve the **devel
 Please consult our [general guidelines](#general-guidelines).
 
 - Easy to use :white_check_mark:
-- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
 - Fixed and dynamic pool size :white_check_mark:
 - Easy switch from a pool type to another :white_check_mark:
+- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
 - No runtime dependencies :white_check_mark:
 - Proper integration with Node.js [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark:
 - Support for CommonJS, ESM, and TypeScript :white_check_mark:
@@ -45,6 +45,11 @@ Please consult our [general guidelines](#general-guidelines).
 - Support for multiple task functions :white_check_mark:
 - Support for sync and async task functions :white_check_mark:
 - Tasks distribution strategies :white_check_mark:
+- Lockless tasks queueing :white_check_mark:
+- Queued tasks rescheduling:
+  - Task stealing :white_check_mark:
+  - Tasks stealing under back pressure :white_check_mark:
+  - Tasks redistribution on worker error :white_check_mark:
 - General guidelines on pool choice :white_check_mark:
 - Error handling out of the box :white_check_mark:
 - Widely tested :white_check_mark:
@@ -74,7 +79,7 @@ Please consult our [general guidelines](#general-guidelines).
 
 Poolifier contains two [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker)/[cluster](https://nodejs.org/api/cluster.html#cluster_class_worker) worker pool implementations, you don't have to deal with [worker_threads](https://nodejs.org/api/worker_threads.html)/[cluster](https://nodejs.org/api/cluster.html) complexity.  
 The first implementation is a fixed worker pool, with a defined number of workers that are started at creation time and will be reused.  
-The second implementation is a dynamic worker pool, with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the new created workers will be stopped after a configurable period of inactivity.  
+The second implementation is a dynamic worker pool, with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the newly created workers will be stopped after a configurable period of inactivity.  
 You have to implement your worker by extending the _ThreadWorker_ or _ClusterWorker_ class.
 
 ## Installation
@@ -128,7 +133,7 @@ pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
 pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
 
 // the execute method signature is the same for both implementations,
-// so you can easy switch from one to another
+// so you can easily switch from one to another
 pool
   .execute()
   .then((res) => {
@@ -173,9 +178,9 @@ Node.js versions >= 16.14.x are supported.
 
 ## Contribute
 
-Choose your task here [2.6.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
+Choose your task [here](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
 
-See [CONTRIBUTING](CONTRIBUTING.md) guidelines.
+See [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
 
 ## Team
 
@@ -183,11 +188,14 @@ See [CONTRIBUTING](CONTRIBUTING.md) guidelines.
 
 - [**Alessandro Pio Ardizio**](https://github.com/pioardi)
 
-**_Contributors_**
+**Maintainers:**
 
-- [**Shinigami92**](https://github.com/Shinigami92)
 - [**Jérôme Benoit**](https://github.com/jerome-benoit)
 
+**Contributors:**
+
+- [**Shinigami92**](https://github.com/Shinigami92)
+
 ## License
 
 [MIT](./LICENSE)