X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=README.md;h=6db467fdbef07444b65082a53740b37f8a5d06b8;hb=275401fc730c1d65e12a6ee22308a22af35da734;hp=3109ddf7b227e9a0269f9d14339f985f52996eec;hpb=fc7a7c640d3df519a4704780494dbda545fd07d9;p=poolifier.git
diff --git a/README.md b/README.md
index 3109ddf7..6db467fd 100644
--- a/README.md
+++ b/README.md
@@ -2,29 +2,25 @@
-
Node.js Worker_Threads and Cluster Worker Pool
+
+
+# Node.js Worker_Threads and Cluster Worker Pool
+
+
-
- ![GitHub commit activity (master)](https://img.shields.io/github/commit-activity/m/poolifier/poolifier/master?color=brightgreen&logo=github)
-
- ![Weekly Downloads](https://badgen.net/npm/dw/poolifier?icon=npm)
-
- ![Actions Status](https://github.com/poolifier/poolifier/actions/workflows/ci.yml/badge.svg)
-
- ![Code Coverage](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage)
-
- ![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status)
-
- ![Javascript Standard Style Guide](https://badgen.net/static/code style/standard/green)
-
- ![Discord](https://badgen.net/discord/online-members/85VrP8m8?icon=discord&label=discord&color=green)
-
- ![Open Collective](https://opencollective.com/poolifier/tiers/badge.svg)
-
- ![PRs welcome](https://badgen.net/static/PRs/welcome/green)
-
- ![No dependencies](https://badgen.net/static/dependencies/no dependencies/green)
+
+[![GitHub commit activity (master)](https://img.shields.io/github/commit-activity/m/poolifier/poolifier/master?color=brightgreen&logo=github)](https://github.com/poolifier/poolifier/graphs/commit-activity)
+[![Weekly Downloads](https://badgen.net/npm/dw/poolifier?icon=npm)](https://www.npmjs.com/package/poolifier)
+[![CI Workflow](https://github.com/poolifier/poolifier/actions/workflows/ci.yml/badge.svg)](https://github.com/poolifier/poolifier/actions/workflows/ci.yml)
+[![Code Coverage](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+[![Javascript Standard Style Guide](
)](https://standardjs.com)
+[![Discord](https://badgen.net/discord/online-members/vXxZhyb3b6?icon=discord&label=discord&color=green)](https://discord.gg/vXxZhyb3b6)
+[![Open Collective](https://opencollective.com/poolifier/tiers/badge.svg)](https://opencollective.com/poolifier)
+[![PRs Welcome](https://badgen.net/static/PRs/welcome/green)](http://makeapullrequest.com)
+[![No Dependencies]()]()
+
## Why Poolifier?
@@ -40,15 +36,15 @@ Please consult our [general guidelines](#general-guidelines).
- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
- No runtime dependencies :white_check_mark:
- Proper integration with Node.js [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark:
-- Support for CommonJS, ESM, and TypeScript :white_check_mark:
+- Support for CommonJS, ESM and TypeScript :white_check_mark:
- Support for [worker_threads](https://nodejs.org/api/worker_threads.html) and [cluster](https://nodejs.org/api/cluster.html) Node.js modules :white_check_mark:
- Support for multiple task functions :white_check_mark:
-- Support for task functions CRUD operations at runtime :white_check_mark:
+- Support for task functions [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations at runtime :white_check_mark:
- Support for sync and async task functions :white_check_mark:
- Tasks distribution strategies :white_check_mark:
- Lockless tasks queueing :white_check_mark:
- Queued tasks rescheduling:
- - Task stealing :white_check_mark:
+ - Task stealing on empty queue :white_check_mark:
- Tasks stealing under back pressure :white_check_mark:
- Tasks redistribution on worker error :white_check_mark:
- General guidelines on pool choice :white_check_mark:
@@ -120,8 +116,8 @@ const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
onlineHandler: () => console.info('worker is online')
})
-pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
-pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
+pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready'))
+pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))
// or a dynamic worker_threads pool
const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), availableParallelism(), './yourWorker.js', {
@@ -129,9 +125,9 @@ const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), avail
onlineHandler: () => console.info('worker is online')
})
-pool.emitter.on(PoolEvents.full, () => console.info('Pool is full'))
-pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
-pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
+pool.emitter?.on(PoolEvents.full, () => console.info('Pool is full'))
+pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready'))
+pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))
// the execute method signature is the same for both implementations,
// so you can easily switch from one to another
@@ -169,7 +165,7 @@ Remember that workers can only send and receive structured-cloneable data.
## Node.js versions
-Node.js versions >= 16.14.x are supported.
+Node.js versions >= 18.x.x are supported.
## [API](./docs/api.md)