From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 10 Jun 2023 10:26:49 +0000 (+0200)
Subject: docs: refine README
X-Git-Tag: v2.6.1~11
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=5e5ea237b14d14484a9f5eb2d5ca8f01de546cfd;p=poolifier.git

docs: refine README

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/README.md b/README.md
index d3a4534f..6f94626a 100644
--- a/README.md
+++ b/README.md
@@ -150,7 +150,7 @@ Node versions >= 16.14.x are supported.
 
 ## [API](https://poolifier.github.io/poolifier/)
 
-### Pool options
+### `PoolOptions`
 
 An object with these properties:
 
@@ -196,11 +196,11 @@ An object with these properties:
 
   Default: `{ concurrency: 1 }`
 
-#### Thread pool specific options
+#### `ThreadPoolOptions`
 
 - `workerOptions` (optional) - An object with the worker options. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details.
 
-#### Cluster pool specific options
+#### `ClusterPoolOptions`
 
 - `env` (optional) - An object with the environment variables to pass to the worker. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_fork_env) for more details.