Update README.MD

[poolifier.git] / README.MD

diff --git a/README.MD b/README.MD
index 3d7c4bfd8184d3e5badb573836733638c2e53b01..af80d5d02481998eeb646bf82c05f6be886cc8bb 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -11,6 +11,8 @@
   <span> · </span>
   <a href="#api">API</a>
   <span> · </span>
+  <a href="#cyp">Choose a pool</a>
+  <span> · </span>
   <a href="#contribute">Contribute</a>
   <span> · </span>
   <a href="#nv">Compatibility</a>
@@ -20,8 +22,8 @@
 
 <h2> Overview </h2>
 Node pool contains two <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a> pool implementations , you don' t have to deal with worker-threads complexity. <br>
-The first implementation is a static thread pool , with a defined number of threads that are started at creation time .<br>
-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 ), the new created threads will be stopped after a threshold. <br>
+The first implementation is a static thread pool , with a defined number of threads that are started at creation time and will be reused.<br>
+The second implementation is a dynamic thread pool with a number of threads started at creation time ( these threads will be always active and reused) and other threads created when the load will increase ( with an upper limit ), the new created threads will be stopped after a configurable period of inactivity. <br>
 You have to implement your worker extending the ThreadWorker class<br>
 <h2 id="installation">Installation</h2>
 
@@ -108,6 +110,15 @@ This method will call the terminate method on each worker.
 `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.
 
+<h2 id="cyp">Choose your pool</h2>
+Performance is one of the main target of these thread pool implementation, we want to have a strong focus on this.<br>
+We already have a bench folder where you can find some comparisons.
+To choose your pool consider that with a FixedThreadPool or a DynamicThreadPool ( in this case is important the min parameter passed to the constructor) your application memory footprint will increase . <br>
+Increasing the memory footprint your application will be ready to accept more CPU bound tasks, but during idle time your application will consume more memory. <br>
+One good choose from my point of view is to profile your application using Fixed/Dynamic thread pool , and to see your application metrics when you increase/decrease the num of threads. <br>
+For example you could keep the memory footprint low choosing a DynamicThreadPool with 5 threads, and allow to create new threads until 50/100 when requests, this is the advantage to use the DynamicThreadPool. <br>
+But in general , <strong>always profile your application </strong>
+
 <h2 id="contribute">Contribute</h2>
 
 See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
@@ -115,5 +126,5 @@ See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
 
 <h2 id="license">License</h2>
 
-[MIT](https://github.com/pioardi/node-pool/blob/master/LICENSE)
+[MIT](./LICENSE)