X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=318d861108789ca96713fc3b1d53563e8f4fa953;hb=7a923e5bc16ae3524c51bedd70c65ce6cc556fdc;hp=ea23397fdf2f3f9a0a5fe2a40ad4035a639b370a;hpb=b492f20e3619b6fbb83bff2f33a6d027b2a758be;p=poolifier.git diff --git a/README.md b/README.md index ea23397f..318d8611 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -

Node Thread Pool and Cluster Pool :arrow_double_up: :on:

+

Node.js Worker_Threads and Cluster Worker Pool

@@ -57,27 +57,18 @@ Please consult our [general guidelines](#general-guidelines). [![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 - -

- Overview - · - Installation - · - Usage - · - Node versions - · - API - · - General guidelines - · - Contribute - · - Team - · - License -

+## 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/javascript/) +- [Typescript](./examples/typescript/) + - [HTTP client pool](./examples/typescript/http-client/) Remember that workers can only send and receive structured-cloneable data. @@ -160,7 +155,9 @@ Node versions >= 16.14.x are supported. ## [API](./docs/api.md) -## [General Guidelines](./docs/general-guidelines.md) +## [General guidelines](./docs/general-guidelines.md) + +## [Worker choice strategies](./docs/worker-choice-strategies.md) ## Contribute