-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
36 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# go-jobqueue | ||
|
||
A simple job queue built on top of BadgerDB. | ||
<a href="https://codecov.io/gh/Argus-Labs/go-jobqueue" > | ||
<img src="https://codecov.io/gh/Argus-Labs/go-jobqueue/graph/badge.svg?token=zvfS7xcv50" alt="Codecov" /> | ||
</a> | ||
|
||
<a href="https://goreportcard.com/report/argus-labs/go-jobqueue"> | ||
<img src="https://goreportcard.com/badge/argus-labs/go-jobqueue" alt="Go Report Card" /> | ||
</a> | ||
|
||
<a href="https://pkg.go.dev/argus-labs/go-jobqueue"> | ||
<img src="https://pkg.go.dev/badge/argus-labs/go-jobqueue.svg" alt="Go Reference" /> | ||
</a> | ||
|
||
<br /> | ||
<br /> | ||
|
||
**go-jobqueue** is a durable embedded job queue for Go apps built on top of [BadgerDB](https://github.com/dgraph-io/badger) that provides a simple API for enqueuing jobs and processing them asynchronously. | ||
|
||
It can be used as a lightweight alternative to a full-fledged durable queue such as [RabbitMQ](https://www.rabbitmq.com). | ||
|
||
**Warning:** this package is a work in progress, use at your own risk. | ||
|
||
## Features | ||
- Easily integrates with any existing Go programs with no service dependencies (i.e. RabbitMQ). | ||
- Automatic job processing with support for multiple concurrent workers. | ||
- Queued jobs are durable and can be reprocessed on a program crash. | ||
- Strong type safety using generics. | ||
- ACID guarantees provided by BadgerDB. | ||
|
||
## Installation | ||
|
||
```bash | ||
go get github.com/argus-labs/go-jobqueue | ||
``` |