Merge pull request #31 from NeoyeElf/feat/support-async-func

[poolifier.git] / README.MD

diff --git a/README.MD b/README.MD
index 5ab240770bf7e7c4c4728b2cac75a57aab82ace9..ca3d51b70e22d44b006cec2064935c732913de2a 100644 (file)
--- 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,15 +56,10 @@ function yourFunction (data) {
   return { ok: 1 }
 }
 
-class MyWorker extends ThreadWorker {
-  constructor () {
-    super(yourFunction, { maxInactiveTime: 1000 * 60})
-  }
-}
-module.exports = new MyWorker()
+module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000 })
 ```
 
-Instantiate your pool based on your needed : 
+Instantiate your pool based on your needed :
 
 ```js
 'use strict'
@@ -131,7 +133,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>