From d1edd355a7d5dc9520c02a5e01bbed808746eb38 Mon Sep 17 00:00:00 2001
From: Scott Sunarto <github@smsunarto.com>
Date: Thu, 27 Jun 2024 20:16:55 -0700
Subject: [PATCH] chore: update README.md

---
 .github/workflows/test.yaml |  4 +++-
 README.md                   | 34 +++++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
index 6625526..ec89a44 100644
--- a/.github/workflows/test.yaml
+++ b/.github/workflows/test.yaml
@@ -23,4 +23,6 @@ jobs:
       - name: Run Unit Test
         run: make test
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
\ No newline at end of file
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
\ No newline at end of file
diff --git a/README.md b/README.md
index 1055e62..a4fcea0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # go-jobqueue
 
-A simple job queue built on top of BadgerDB.
\ No newline at end of file
+<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
+```