Skip to content

Commit db27b18

Browse files
committed
Update package.json and readme
1 parent 44caf90 commit db27b18

File tree

3 files changed

+26
-23
lines changed

3 files changed

+26
-23
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# bottleneck
22

3-
[![Downloads][npm-downloads]][npm-url]
4-
[![version][npm-version]][npm-url]
5-
[![License][npm-license]][license-url]
6-
7-
83
Bottleneck is a lightweight and zero-dependency Task Scheduler and Rate Limiter for Node.js and the browser.
94

105
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.
116

127
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*.
138

14-
**[Upgrading from version 1?](#upgrading-to-v2)**
9+
## Why this fork exists
10+
11+
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:
12+
13+
- [Redis 7 error message handling](https://github.com/sderrow/bottleneck/commit/e479267fe5120db0432652c31753dc9e16969be8)
14+
- [updateSettings not working for local datastore](https://github.com/sderrow/bottleneck/pull/3)
15+
- [Typescript fixes](https://github.com/sderrow/bottleneck/commit/62e1cf43ae639ab25181f5d544692ad6098eb9ce) and [enhancements](https://github.com/sderrow/bottleneck/commit/44caf901fd8e0af06c4aba6572276a44e5ef2a13)
16+
17+
### No breaking changes
18+
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`.
19+
20+
## Table of Contents
1521

1622
<!-- toc -->
1723

@@ -1021,9 +1027,4 @@ The tests must also pass in Clustering mode and using the ES5 bundle. You'll nee
10211027

10221028
All contributions are appreciated and will be considered.
10231029

1024-
[license-url]: https://github.com/SGrondin/bottleneck/blob/master/LICENSE
1025-
1026-
[npm-url]: https://www.npmjs.com/package/bottleneck
1027-
[npm-license]: https://img.shields.io/npm/l/bottleneck.svg?style=flat
1028-
[npm-version]: https://img.shields.io/npm/v/bottleneck.svg?style=flat
1029-
[npm-downloads]: https://img.shields.io/npm/dm/bottleneck.svg?style=flat
1030+
[license-url]: https://github.com/sderrow/bottleneck/blob/master/LICENSE

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
{
2-
"name": "bottleneck",
3-
"version": "2.19.5",
2+
"name": "@sderrow/bottleneck",
3+
"version": "3.0.4",
44
"description": "Distributed task scheduler and rate limiter",
55
"main": "lib/index.js",
66
"typings": "bottleneck.d.ts",
77
"scripts": {
88
"test": "mocha test",
99
"test-all": "./scripts/test_all.sh"
1010
},
11-
"repository": {
12-
"type": "git",
13-
"url": "https://github.com/SGrondin/bottleneck"
14-
},
11+
"repository": "github:sderrow/bottleneck",
1512
"keywords": [
1613
"async rate limiter",
1714
"rate limiter",
@@ -29,9 +26,14 @@
2926
"author": {
3027
"name": "Simon Grondin"
3128
},
29+
"contributors": [
30+
{
31+
"name": "Sean Derrow"
32+
}
33+
],
3234
"license": "MIT",
3335
"bugs": {
34-
"url": "https://github.com/SGrondin/bottleneck/issues"
36+
"url": "https://github.com/sderrow/bottleneck/issues"
3537
},
3638
"devDependencies": {
3739
"@babel/core": "^7.5.0",

0 commit comments

Comments
 (0)