Update README.MD

[poolifier.git] / README.MD

diff --git a/README.MD b/README.MD
index 677199800a85c42a5a6cd9a9a468be1b7ab38524..3963a10d368d46c2f461df977726e24f0c809cfc 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -2,12 +2,19 @@
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![Dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
 [![Actions Status](https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg)](https://github.com/pioardi/node-pool/actions)
-[![Coverage Status](https://coveralls.io/repos/github/pioardi/node-thread-pool/badge.svg)](https://coveralls.io/github/pioardi/node-thread-pool)
+[![Coverage Status](https://coveralls.io/repos/github/pioardi/node-thread-pool/badge.svg?branch=master)](https://coveralls.io/github/pioardi/node-thread-pool?branch=master)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![NODEP](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
 )](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>
@@ -33,7 +40,7 @@ You have to implement your worker extending the ThreadWorker class<br>
 <h2 id="installation">Installation</h2>
 
 ```
-npm install node-thread-pool --save
+npm install poolifier --save
 ```
 <h2 id="usage">Usage</h2>
 
@@ -41,7 +48,7 @@ You can implement a worker in a simple way , extending the class ThreadWorker :
 
 ```js
 'use strict'
-const { ThreadWorker } = require('node-pool')
+const { ThreadWorker } = require('poolifier')
 
 function yourFunction (data) {
   // this will be executed in the worker thread,
@@ -49,19 +56,14 @@ 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, async: false })
 ```
 
-Instantiate your pool based on your needed : 
+Instantiate your pool based on your needed :
 
 ```js
 'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('node-pool')
+const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
 
 // a fixed thread pool
 const pool = new FixedThreadPool(15,
@@ -87,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>
 
@@ -119,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>
@@ -131,10 +134,10 @@ But in general , <strong>always profile your application </strong>
 
 <h2 id="contribute">Contribute</h2>
 
-See guidelines [CONTRIBUTING](./.github/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>
 
 [MIT](./LICENSE)
-