diff --git a/README.md b/README.md index d9d9cf7..2d0c9e8 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,18 @@ > [!IMPORTANT] > Dotkernel component used to queue tasks to be processed asynchronously based on [netglue/laminas-messenger](https://github.com/netglue/laminas-messenger) + A queue system is a vital component in modern web applications that enables the decoupling of certain tasks from the regular request-response cycle. + + This is especially useful for time-consuming and resource-intensive operations which are thus handled asynchronously by background workers on a separate system. + +The greatest benefit is to application responsiveness which allows faster execution, while the heavy lifting is scheduled in the queue based on available resources. + + The queue system uses logs to ensure maintainability and implements retry features for reliability and stability. + Queue process + + ## Badges ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/queue) @@ -20,6 +30,7 @@ [![Qodana](https://github.com/dotkernel/queue/actions/workflows/qodana_code_quality.yml/badge.svg?branch=main)](https://github.com/dotkernel/queue/actions/workflows/qodana_code_quality.yml) [![PHPStan](https://github.com/dotkernel/queue/actions/workflows/static-analysis.yml/badge.svg?branch=main)](https://github.com/dotkernel/queue/actions/workflows/static-analysis.yml) + ## Installation > Until we have a compiled documentation, read the files from /doc/book/v1 folder