From e3fa2f50553fc68ef5dba4ce616c95b68e30ba30 Mon Sep 17 00:00:00 2001
From: michalsn <michal@sniatala.pl>
Date: Sat, 14 Oct 2023 15:57:34 +0200
Subject: [PATCH] add readme

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e7af099
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# CodeIgniter Queue
+
+Queues for the CodeIgniter 4 framework.
+
+[![PHPUnit](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpunit.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpunit.yml)
+[![PHPStan](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpstan.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpstan.yml)
+[![Deptrac](https://github.com/michalsn/codeigniter-queue/actions/workflows/deptrac.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/deptrac.yml)
+[![Coverage Status](https://coveralls.io/repos/github/michalsn/codeigniter-queue/badge.svg?branch=develop)](https://coveralls.io/github/michalsn/codeigniter-queue?branch=develop)
+
+![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)
+![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
+
+## Installation
+
+    composer require michalsn/codeigniter-queue
+
+Migrate your database:
+
+    php spark migrate --all
+
+## Configuration
+
+Publish configuration file:
+
+    php spark queue:publish
+
+Create your first Job:
+
+    php spark queue:job Example
+
+Add it to the `$jobHandlers` array in the `app\Config\Queue.php` file:
+
+```php
+// ...
+
+use App\Jobs\Example;
+
+// ...
+
+public array $jobHandlers = [
+    'my-example' => Example::class
+];
+
+// ...
+```
+
+## Basic usage
+
+Add job to the queue:
+
+```php
+service('queue')->push('queueName', 'my-example', ['data' => 'array']);
+```
+
+Run the queue worker:
+
+    php spark queue:work queueName
+
+## Docs
+
+https://michalsn.github.io/codeigniter-queue/