X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.MD;h=a517aecdef9abcd5ed8055943292d1af30a9af63;hb=28b6da3ee4b137ac3737efbe1516b3861c925d42;hp=d7b5bd329e3b737e74792451952f79eefa9cc000;hpb=766e51a0c50e4aadad5f8c65a2b6689d91ba75d8;p=poolifier.git
diff --git a/README.MD b/README.MD
index d7b5bd32..a517aecd 100644
--- a/README.MD
+++ b/README.MD
@@ -3,7 +3,66 @@
[![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)
-Node pool contains two worker-threads pool implementations.
+Node pool contains two worker-threads pool implementations , you don' t have to deal with worker-threads complexity.
The first implementation is a static thread pool , with a defined number of threads that are started at creation time .
The second implementation is a dynamic thread pool with a number of threads started at creation time and other threads created when the load will increase ( with an upper limit ).
+## Installation
+```
+npm install node-pool --save
+```
+# Usage
+
+You can implement a worker in a simple way , extending the class ThreadWorker :
+
+```js
+'use strict'
+const { ThreadWorker } = require('node-pool')
+
+class MyWorker extends ThreadWorker {
+ constructor () {
+ super((data) => {
+ // this will be executed in the worker thread, the data will be received by using the execute method
+ return { ok: 1 }
+ })
+ }
+}
+module.exports = new MyWorker()
+```
+
+Instantiate your pool based on your needed :
+
+```js
+'use strict'
+const { FixedThreadPool } = require('node-pool')
+
+// a fixed thread pool
+const pool = new FixedThreadPool(15,
+ './yourWorker.js')
+
+// or a dynamic thread pool
+const pool = new DynamicThreadPool(10, 100,
+ './yourWorker.js')
+pool.emitter.on('FullPool', () => console.log('Pool is full'))
+
+// the execute method signature is the same for both implementations,
+// so you can easy switch from one to another
+pool.execute({}).then(res => {
+ console.log(res)
+}).catch ....
+
+```
+
+ See examples folder for more details.
+
+## Node versions
+You can use node version 10.x with --experimental-worker flag, or you can use 12.x version
+
+## API
+
+TODO
+
+## License
+
+[MIT](https://github.com/pioardi/node-pool/blob/master/LICENSE)
+