X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=README.MD;h=ca3d51b70e22d44b006cec2064935c732913de2a;hb=a06c72d6a04f3e5e7f9abb48bdf24926e1d81029;hp=35080cbf7fa7032cbf20bb9d9e68e076b99e8b67;hpb=106744f7518d0f64ce85c4507157092083c2c4d4;p=poolifier.git
diff --git a/README.MD b/README.MD
index 35080cbf..ca3d51b7 100644
--- a/README.MD
+++ b/README.MD
@@ -2,11 +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?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
)
+
Why Poolifier?
+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 worker-threads .
+With poolifier you can improve your performance and resolve problems related to the event loop.
+Moreover you can execute your CPU tasks using an API designed to improve the developer experience.
+
+
+
Contents
Installation
@@ -32,7 +40,7 @@ You have to implement your worker extending the ThreadWorker class
Installation
```
-npm install node-thread-pool --save
+npm install poolifier --save
```
Usage
@@ -40,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,
@@ -48,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 })
```
-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,
@@ -86,7 +89,7 @@ pool.execute({}).then(res => {
Node versions
-You can use node version 10.x with --experimental-worker flag, or you can use an higher version (i.e 12.x)
+You can use node versions 12.x , 13.x
API
@@ -130,10 +133,10 @@ But in general , always profile your application
Contribute
-See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+Choose your task here 2.0.0, propose an idea, a fix, an improvement.
License
[MIT](./LICENSE)
-