X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=README.MD;h=3963a10d368d46c2f461df977726e24f0c809cfc;hb=695b7a99868082d63ab01c0946ca8d19f63ba27a;hp=7b57162a1b29b28efb9951f54a950f4a80b38c70;hpb=1f9a5a440caea7dc60a664d413304250969bb4d8;p=poolifier.git

diff --git a/README.MD b/README.MD
index 7b57162a..3963a10d 100644
--- a/README.MD
+++ b/README.MD
@@ -8,6 +8,13 @@
 )](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
 )
 
+<h2>Why Poolifier? </h2>
+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>.
+
+
+
 <h2>Contents </h2>
 <h3 align="center">
   <a href="#installation">Installation</a>
@@ -49,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 :
@@ -82,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>
 
@@ -114,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>
@@ -126,7 +134,8 @@ But in general , <strong>always profile your application </strong>
 
 <h2 id="contribute">Contribute</h2>
 
-See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md) <br>
+Choose your task here <a href="https://github.com/pioardi/poolifier/projects/1"> 2.0.0</a>, propose an idea, a fix, an improvement. <br>  
 
 
 <h2 id="license">License</h2>