Commit b9ac829

authored

docs: add clarification for queue usage scenarios (#53)

* add clarification for queue usage scenarios * fix wording

1 parent 16fd35b commit b9ac829Copy full SHA for b9ac829

File tree

-1

lines changed

-1

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ Queues for the CodeIgniter 4 framework.`
`11`	`11`	`![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)`
`12`	`12`	`![License](https://img.shields.io/badge/License-MIT-blue)`
`13`	`13`
	`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`	`+`
`14`	`17`	`## Installation`
`15`	`18`
`16`	`19`	`composer require codeigniter4/queue`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,11 @@`
`2`	`2`
`3`	`3`	`A library that helps you handle Queues in the CodeIgniter 4 framework.`
`4`	`4`
`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.`
`6`	`10`
`7`	`11`	```php
`8`	`12`	`service('queue')->push('queueName', 'jobName', ['array' => 'parameters']);`

Comments

(0)