docs: add links to examples

[poolifier.git] / README.md

diff --git a/README.md b/README.md
index c708c73e5bec44ba9474f6c5587c5f3ec452f83a..77de1272a31d7c82777a6a334d9d8c71911cd0c5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
   <img src="./images/logo.png" width="340px" height="266px"/>
 </div>
 
-<h2 align="center">Node Thread Pool and Cluster Pool :arrow_double_up: :on:</h2>
+<h1 align="center">Node.js Worker_Threads and Cluster Worker Pool</h1>
 
 <p align="center">
   <a href="https://github.com/poolifier/poolifier/graphs/commit-activity">
@@ -32,7 +32,7 @@
 Poolifier is used to perform CPU and/or I/O intensive tasks on Node.js servers, it implements worker pools using [worker_threads](https://nodejs.org/api/worker_threads.html) and [cluster](https://nodejs.org/api/cluster.html) Node.js modules.  
 With poolifier you can improve your **performance** and resolve problems related to the event loop.  
 Moreover you can execute your tasks using an API designed to improve the **developer experience**.  
-Please consult our [general guidelines](#general-guidance).
+Please consult our [general guidelines](#general-guidelines).
 
 - Easy to use :white_check_mark:
 - Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
@@ -45,7 +45,7 @@ Please consult our [general guidelines](#general-guidance).
 - Support multiple task functions :white_check_mark:
 - Support sync and async task functions :white_check_mark:
 - Tasks distribution strategies :white_check_mark:
-- General guidance on pool choice :white_check_mark:
+- General guidelines on pool choice :white_check_mark:
 - Error handling out of the box :white_check_mark:
 - Widely tested :white_check_mark:
 - Active community :white_check_mark:
@@ -57,27 +57,18 @@ Please consult our [general guidelines](#general-guidance).
   [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_index)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
 - Code security [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=security_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
 
-## Contents
-
-<h3 align="center">
-  <a href="#overview">Overview</a>
-  <span> · </span>
-  <a href="#installation">Installation</a>
-  <span> · </span>
-  <a href="#usage">Usage</a>
-  <span> · </span>
-  <a href="#node-versions">Node versions</a>
-  <span> · </span>
-  <a href="#api">API</a>
-  <span> · </span>
-  <a href="#general-guidance">General guidance</a>
-  <span> · </span>
-  <a href="#contribute">Contribute</a>
-  <span> · </span>
-  <a href="#team">Team</a>
-  <span> · </span>
-  <a href="#license">License</a>
-</h3>
+## Table of contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Node versions](#node-versions)
+- [API](#api)
+- [General guidelines](#general-guidelines)
+- [Worker choice strategies](#worker-choice-strategies)
+- [Contribute](#contribute)
+- [Team](#team)
+- [License](#license)
 
 ## Overview
 
@@ -150,7 +141,11 @@ pool
 
 You can do the same with the classes _ClusterWorker_, _FixedClusterPool_ and _DynamicClusterPool_.
 
-**See [examples](./examples/) folder for more details (in particular if you want to use a pool with [multiple task functions](./examples/multiFunctionExample.js))**.
+**See [examples](./examples/) folder for more details**:
+
+- [Javascript](./examples/)
+- [Typescript](./examples/typescript/)
+  - [HTTP client pool](./examples/typescript/http-client/)
 
 Remember that workers can only send and receive structured-cloneable data.
 
@@ -158,13 +153,11 @@ Remember that workers can only send and receive structured-cloneable data.
 
 Node versions >= 16.14.x are supported.
 
-## [API](https://poolifier.github.io/poolifier/)
-
-[**API Details**](./docs/api-details.md)
+## [API](./docs/api.md)
 
-## General Guideline
+## [General guidelines](./docs/general-guidelines.md)
 
-For general guidelines, please refer to [this document](./docs/general-guidelines.md)
+## [Worker choice strategies](./docs/worker-choice-strategies.md)
 
 ## Contribute