Skip to content

Commit

Permalink
docs: add clarification for queue usage scenarios (#53)
Browse files Browse the repository at this point in the history
* add clarification for queue usage scenarios

* fix wording
  • Loading branch information
michalsn authored Jan 19, 2025
1 parent 16fd35b commit b9ac829
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Queues for the CodeIgniter 4 framework.
![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
![License](https://img.shields.io/badge/License-MIT-blue)

> [!NOTE]
> 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.
## Installation

composer require codeigniter4/queue
Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

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

Add job to the queue.
!!! info "What are queues used for?"

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.

Add a job to the queue.

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

0 comments on commit b9ac829

Please sign in to comment.