Skip to content

Commit b9ac829

Browse files
authored
docs: add clarification for queue usage scenarios (#53)
* add clarification for queue usage scenarios * fix wording
1 parent 16fd35b commit b9ac829

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Queues for the CodeIgniter 4 framework.
1111
![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
1212
![License](https://img.shields.io/badge/License-MIT-blue)
1313

14+
> [!NOTE]
15+
> A queue system is typically used to handle resource-intensive or time-consuming tasks (e.g., image processing, sending emails) that are to be run in the background. It can also be a way to postpone certain activities that are to be executed automatically later.
16+
1417
## Installation
1518

1619
composer require codeigniter4/queue

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
A library that helps you handle Queues in the CodeIgniter 4 framework.
44

5-
Add job to the queue.
5+
!!! info "What are queues used for?"
6+
7+
A queue system is typically used to handle resource-intensive or time-consuming tasks (e.g., image processing, sending emails) that are to be run in the background. It can also be a way to postpone certain activities that are to be executed automatically later.
8+
9+
Add a job to the queue.
610

711
```php
812
service('queue')->push('queueName', 'jobName', ['array' => 'parameters']);

0 commit comments

Comments
 (0)