X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=README.MD;h=ca3d51b70e22d44b006cec2064935c732913de2a;hb=416f383977987a2af95fd8f429be26af10d50c7f;hp=249d770277c49a8a5f7e64e2b36d16cff988dbc8;hpb=fd28144f14b527b492db5dcb1765987747ca4005;p=poolifier.git
diff --git a/README.MD b/README.MD
index 249d7702..ca3d51b7 100644
--- a/README.MD
+++ b/README.MD
@@ -8,6 +8,13 @@
)](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
@@ -33,7 +40,7 @@ You have to implement your worker extending the ThreadWorker class
Installation
```
-npm install @pioardi/node-thread-pool --save
+npm install poolifier --save
```
Usage
@@ -41,7 +48,7 @@ You can implement a worker in a simple way , extending the class ThreadWorker :
```js
'use strict'
-const { ThreadWorker } = require('@pioardi/node-thread-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 })
```
-Instantiate your pool based on your needed :
+Instantiate your pool based on your needed :
```js
'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('@pioardi/node-thread-pool')
+const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
// a fixed thread pool
const pool = new FixedThreadPool(15,
@@ -131,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)
-