From db27b1861fae14a73c93522f2feddb1ab2a5bcc3 Mon Sep 17 00:00:00 2001
From: Sean Derrow <sean.derrow@gmail.com>
Date: Sun, 27 Apr 2025 13:37:37 -0400
Subject: [PATCH] Update package.json and readme

---
 README.md         | 25 +++++++++++++------------
 package-lock.json |  8 ++++----
 package.json      | 16 +++++++++-------
 3 files changed, 26 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index ea0c863..043d25e 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,23 @@
 # bottleneck
 
-[![Downloads][npm-downloads]][npm-url]
-[![version][npm-version]][npm-url]
-[![License][npm-license]][license-url]
-
-
 Bottleneck is a lightweight and zero-dependency Task Scheduler and Rate Limiter for Node.js and the browser.
 
 Bottleneck is an easy solution as it adds very little complexity to your code. It is battle-hardened, reliable and production-ready and used on a large scale in private companies and open source software.
 
 It supports **Clustering**: it can rate limit jobs across multiple Node.js instances. It uses Redis and strictly atomic operations to stay reliable in the presence of unreliable clients and networks. It also supports *Redis Cluster* and *Redis Sentinel*.
 
-**[Upgrading from version 1?](#upgrading-to-v2)**
+## Why this fork exists
+
+The original [bottleneck library](https://github.com/SGrondin/bottleneck) appears no longer maintained, so this is a fork that addresses a few key issues that have been identified in the last few years:
+
+- [Redis 7 error message handling](https://github.com/sderrow/bottleneck/commit/e479267fe5120db0432652c31753dc9e16969be8)
+- [updateSettings not working for local datastore](https://github.com/sderrow/bottleneck/pull/3)
+- [Typescript fixes](https://github.com/sderrow/bottleneck/commit/62e1cf43ae639ab25181f5d544692ad6098eb9ce) and [enhancements](https://github.com/sderrow/bottleneck/commit/44caf901fd8e0af06c4aba6572276a44e5ef2a13)
+
+### No breaking changes
+Despite the major version bump, that's just to signify that this is a fork. There are no breaking JS changes right now. Technically, the TypeScript version was bumped to 4.X from 2.6 in order to support variadic tuples for `schedule`, `wrap`, and `submit`.
+
+## Table of Contents
 
 <!-- toc -->
 
@@ -1021,9 +1027,4 @@ The tests must also pass in Clustering mode and using the ES5 bundle. You'll nee
 
 All contributions are appreciated and will be considered.
 
-[license-url]: https://github.com/SGrondin/bottleneck/blob/master/LICENSE
-
-[npm-url]: https://www.npmjs.com/package/bottleneck
-[npm-license]: https://img.shields.io/npm/l/bottleneck.svg?style=flat
-[npm-version]: https://img.shields.io/npm/v/bottleneck.svg?style=flat
-[npm-downloads]: https://img.shields.io/npm/dm/bottleneck.svg?style=flat
+[license-url]: https://github.com/sderrow/bottleneck/blob/master/LICENSE
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index 52d3afb..d7c9ce6 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
-  "name": "bottleneck",
-  "version": "2.19.5",
+  "name": "@sderrow/bottleneck",
+  "version": "3.0.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "bottleneck",
-      "version": "2.19.5",
+      "name": "@sderrow/bottleneck",
+      "version": "3.0.4",
       "license": "MIT",
       "devDependencies": {
         "@babel/core": "^7.5.0",
diff --git a/package.json b/package.json
index e30e5bf..0587663 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "bottleneck",
-  "version": "2.19.5",
+  "name": "@sderrow/bottleneck",
+  "version": "3.0.4",
   "description": "Distributed task scheduler and rate limiter",
   "main": "lib/index.js",
   "typings": "bottleneck.d.ts",
@@ -8,10 +8,7 @@
     "test": "mocha test",
     "test-all": "./scripts/test_all.sh"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SGrondin/bottleneck"
-  },
+  "repository": "github:sderrow/bottleneck",
   "keywords": [
     "async rate limiter",
     "rate limiter",
@@ -29,9 +26,14 @@
   "author": {
     "name": "Simon Grondin"
   },
+  "contributors": [
+    {
+      "name": "Sean Derrow"
+    }
+  ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/SGrondin/bottleneck/issues"
+    "url": "https://github.com/sderrow/bottleneck/issues"
   },
   "devDependencies": {
     "@babel/core": "^7.5.0",