Update README.MD

[poolifier.git] / README.MD

diff --git a/README.MD b/README.MD
index 7dc0a1ed8688bcfc91956ad3face9b3b87397740..3963a10d368d46c2f461df977726e24f0c809cfc 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -9,7 +9,7 @@
 )
 
 <h2>Why Poolifier? </h2>
-Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it implements thread pools ( yes, more thread pool implemenetations, so you can choose which one fit better for you ) using <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a>.<br>
+Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it implements thread pools ( yes, more thread pool implementations, so you can choose which one fit better for you ) using <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a>.<br>
 With poolifier you can improve your <strong>performance</strong> and resolve problems related to the event loop.<br>
 Moreover you can execute your CPU tasks using an API designed to improve the <strong>developer experience</strong>.
 
@@ -56,7 +56,7 @@ function yourFunction (data) {
   return { ok: 1 }
 }
 
-module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000 })
+module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000, async: false })
 ```
 
 Instantiate your pool based on your needed :
@@ -89,7 +89,7 @@ pool.execute({}).then(res => {
 
 <h2 id="nv">Node versions</h2>
 
-You can use node versions 12.x , 13.x  <br>
+You can use node versions 12.x , 13.x, 14.x <br>
 
 <h2 id="api">API</h2>
 
@@ -121,6 +121,7 @@ This method will call the terminate method on each worker.
 `fn` (mandatory) The function that you want to execute on the worker thread <br>
 `opts` (optional) An object with these properties :
 - `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
+- `async` - true/false , true if your function contains async pieces else false
 
 <h2 id="cyp">Choose your pool</h2>
 Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.<br>