X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=1d7e02865f687469043672ced21b473f89a21acb;hb=464609011adfbe9330e28d448d462adcdffa64f5;hp=17c46101e753e251b51257bc230b0ef73841bf49;hpb=50aa790189f6423c52ea72198380dbe93c025e40;p=poolifier.git diff --git a/README.md b/README.md index 17c46101..1d7e0286 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,33 @@ -# Node Thread Pool :arrow_double_up: :on: +
+ +
+ +

Node Thread Pool :arrow_double_up: :on:

+ +

+ + Weekly Downloads + + Actions Status + + Quality Gate Status + + Code coverage + + Javascript Standard Style Guide + + Gitter chat + + Dependabot + + PR Welcome + + No dependencies + +

+ + -[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -[![Dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot) -[![npm w](https://img.shields.io/npm/dw/poolifier)](https://www.npmjs.com/package/poolifier) -[![Actions Status](https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg)](https://github.com/pioardi/node-pool/actions) -[![Coverage Status](https://coveralls.io/repos/github/pioardi/poolifier/badge.svg?branch=master)](https://coveralls.io/github/pioardi/poolifier?branch=master) -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) -[![NODEP](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen)](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen) -[![Gitter](https://badges.gitter.im/poolifier/community.svg)](https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## Why Poolifier? @@ -15,6 +35,28 @@ Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it impleme With poolifier you can improve your **performance** and resolve problems related to the event loop. Moreover you can execute your CPU tasks using an API designed to improve the **developer experience**. +- Performance :racehorse: +- Security :bank: :cop: [![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) + +- No runtime dependencies :heavy_check_mark: +- Easy to use :couple: +- Easy switch from a pool to another, easy to tune +- Dynamic pool size +- Proper async integration with node async hooks +- Support for worker threads and cluster node modules +- Active community +- Support sync and async tasks +- General guidance on pools to use +- Widely tested +- Error handling out of the box +- Code quality :octocat: [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_index)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) + + ## Contents