refactor: cleanup cluster ESM issue workaround
[poolifier.git] / README.md
index df72b0b63f1454b7bc23ce8789f7e69fc2002ca6..9f0fc3dad2ab8bcb483a009c33efe13a3d0aac8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,10 +80,10 @@ Please consult our [general guidelines](#general-guidance).
 
 ## Overview
 
-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/cluster complexity.  
+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 static 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.  
-You have to implement your worker by extending the \_ThreadWorker* or _ClusterWorker_ class.
+You have to implement your worker by extending the _ThreadWorker_ or _ClusterWorker_ class.
 
 ## Installation
 
@@ -138,7 +138,7 @@ 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
 pool
-  .execute({})
+  .execute()
   .then(res => {
     console.info(res)
   })