Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sebamarynissen authored Jan 31, 2024
1 parent 6617943 commit df75618
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# AgendaTS
**DISCLAIMER**: I **do not** intend to actively maintain this repository.
I forked it from https://github.com/hokify/agenda because I desperately needed support for [mongodb@6](https://www.npmjs.com/package/mongodb) for my website www.whisthub.com, but the original repository doesn't seem very active anymore.
Ideally this gets merged back into [@hokify/agenda](https://github.com/hokify/agenda), or even better in [agenda/agenda](https://github.com/agenda/agenda).

(full typed version of agendaJS)
However, I *do* intend to keep this up to date with the latest version of the [mongodb](https://www.npmjs.com/package/mongodb) package, but that's all.
Agenda is a great library and I would hate to see it dying because new mongodb versions are not supported.

# Agenda

<p align="center">
<img src="https://cdn.jsdelivr.net/gh/hokify/agenda@master/agendats.png" alt="Agenda TS" width="100" height="100">
Expand All @@ -13,7 +18,7 @@ This was originally a fork of agenda.js,
it differs from the original version in following points:

- Complete rewrite in Typescript (fully typed!)
- mongodb4 driver (supports mongodb 5.x)
- [mongodb@6](https://www.npmjs.com/package/mongodb) driver (supports mongodb 5.x and mongodb 4.x too)
- Supports mongoDB sharding by name
- touch() can have an optional progress parameter (0-100)
- Bugfixes and improvements for locking & job processing (concurrency, lockLimit,..)
Expand Down

0 comments on commit df75618

Please sign in to comment.