build: comment out JSR include

[poolifier.git] / README.md

diff --git a/README.md b/README.md
index 68e9fe6589ff64573e18eb25a3bd48a8b3ba7650..6f6e79c7cb91e089e1e3a8996446f58f38bffa82 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@
 <div align="center">
 
 [![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)
+[![Npm Version](https://badgen.net/npm/v/poolifier?icon=npm)](https://www.npmjs.com/package/poolifier)
+[![Npm Weekly Downloads](https://badgen.net/npm/dw/poolifier?icon=npm)](https://www.npmjs.com/package/poolifier)
+[![JSR Version](https://jsr.io/badges/@poolifier/poolifier)](https://jsr.io/@poolifier/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=poolifier_poolifier&metric=coverage)](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=poolifier_poolifier&metric=alert_status)](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
@@ -81,17 +83,24 @@ You have to implement your worker by extending the _ThreadWorker_ or _ClusterWor
 
 ## Installation
 
+### npm
+
 ```shell
 npm install poolifier --save
 ```
 
+### jsr
+
+```shell
+npx jsr add @poolifier/poolifier
+```
+
 ## Usage
 
-You can implement a [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker) worker in a simple way by extending the class _ThreadWorker_:
+You can implement a poolifier [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker) worker in a simple way by extending the class _ThreadWorker_:
 
 ```js
-'use strict'
-const { ThreadWorker } = require('poolifier')
+import { ThreadWorker } from 'poolifier'
 
 function yourFunction(data) {
   // this will be executed in the worker thread,
@@ -107,12 +116,11 @@ module.exports = new ThreadWorker(yourFunction, {
 Instantiate your pool based on your needs :
 
 ```js
-'use strict'
-const { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } = require('poolifier')
+import { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } from 'poolifier'
 
 // a fixed worker_threads pool
 const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
-  errorHandler: (e) => console.error(e),
+  errorHandler: e => console.error(e),
   onlineHandler: () => console.info('worker is online')
 })
 
@@ -121,7 +129,7 @@ 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', {
-  errorHandler: (e) => console.error(e),
+  errorHandler: e => console.error(e),
   onlineHandler: () => console.info('worker is online')
 })
 
@@ -133,10 +141,10 @@ pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))
 // so you can easily switch from one to another
 pool
   .execute()
-  .then((res) => {
+  .then(res => {
     console.info(res)
   })
-  .catch((err) => {
+  .catch(err => {
     console.error(err)
   })
 ```