Skip to content

Commit cf9ca13

Browse files
committed
Add more information
1 parent c16510a commit cf9ca13

File tree

1 file changed

+62
-7
lines changed

1 file changed

+62
-7
lines changed

README.md

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,51 @@
44
<img src="https://repository-images.githubusercontent.com/329289269/bf372113-a004-40f2-815b-300155f7a220" alt="Custom SQS queue reader for Laravel" style="width: 100%; max-width: 800px;" />
55
</p>
66

7+
The Laravel SQS Queue Reader is a powerful extension designed to seamlessly integrate external webhooks into your Laravel application. By leveraging the reliability and scalability of Amazon Simple Queue Service (SQS), this extension ensures that your application efficiently processes incoming webhooks, minimizing downtime and enhancing overall performance.
8+
9+
Key Features:
10+
11+
Effortless Webhook Integration:
12+
13+
Easily integrate external webhooks into your Laravel application without compromising on performance.
14+
15+
Queue-Based Processing:
16+
17+
Harness the power of Amazon SQS to queue incoming webhooks, allowing for asynchronous and parallel processing, ensuring optimal response times.
18+
19+
Reliability and Scalability:
20+
21+
SQS provides a robust and scalable infrastructure, ensuring that your application can handle varying webhook loads without compromising on stability.
22+
23+
Seamless Laravel Integration:
24+
25+
Designed as a Laravel extension, the Webhook Queue Reader seamlessly integrates into your Laravel project, following Laravel's coding standards and conventions.
26+
27+
Configurable Settings:
28+
29+
Customize the extension's settings to align with your application's requirements, including queue names, visibility timeout, and other SQS-specific configurations.
30+
31+
Detailed Logging:
32+
33+
Gain insights into the webhook processing flow with detailed logging, helping you troubleshoot and monitor the system effectively.
34+
35+
How It Works:
36+
37+
Webhook Registration:
38+
39+
Register external webhooks with your Laravel application by providing the webhook URL.
40+
41+
SQS Queue Integration:
42+
43+
Incoming webhooks are efficiently processed through the SQS queue, ensuring optimal handling of webhook payloads.
44+
Asynchronous Processing:
45+
46+
Leverage the asynchronous processing capabilities of SQS to handle webhooks in the background, preventing any impact on your application's response times.
47+
48+
Automatic Retries:
49+
50+
Benefit from SQS's automatic retries, ensuring that failed webhook processing attempts are retried without manual intervention.
51+
752
[![Latest Version on Packagist](https://img.shields.io/packagist/v/palpalani/laravel-sqs-queue-json-reader.svg?style=for-the-badge)](https://packagist.org/packages/palpalani/laravel-sqs-queue-json-reader)
853
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/palpalani/laravel-sqs-queue-json-reader/run-tests.yml?branch=main&label=tests&style=for-the-badge)](https://github.com/palpalani/laravel-sqs-queue-json-reader/actions?query=workflow%3Arun-tests+branch%3Amain)
954
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/palpalani/laravel-sqs-queue-json-reader/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=for-the-badge)](https://github.com/palpalani/laravel-sqs-queue-json-reader/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
@@ -14,23 +59,23 @@
1459
-->
1560
<a href="https://php.net"><img alt="PHP 8.1" src="https://img.shields.io/badge/PHP-8.1-777BB4?style=for-the-badge&logo=php"></a>
1661

17-
Custom SQS queue reader for Laravel projects that supports raw JSON payloads and reads multiple messages. Laravel expects SQS messages to be generated in a
18-
specific format that includes job handler class and a serialized job.
62+
Custom SQS queue reader for Laravel projects that supports raw JSON payloads and reads multiple messages. Laravel expects SQS messages to be generated in a specific format that includes job handler class and a serialized job.
1963

2064
Note: Implemented to read multiple messages from queue.
2165

2266
This library is very useful when you want to parse messages from 3rd party
2367
applications such as stripe webhooks, shopify webhooks, mailgun web hooks, custom JSON messages and so on.
2468

25-
## Installation
69+
## Getting Started
2670

27-
You can install the package via composer:
71+
Install Custom SQS queue reader for Laravel via composer:
2872

2973
```bash
3074
composer require palpalani/laravel-sqs-queue-json-reader
3175
```
3276

33-
You can publish the config file with:
77+
You can publish the config file and Configure your SQS settings in the Laravel configuration file.
78+
3479
```bash
3580
php artisan vendor:publish --provider="palPalani\SqsQueueReader\SqsQueueReaderServiceProvider" --tag="config"
3681
```
@@ -69,7 +114,9 @@ return [
69114

70115
If the queue is not found in 'handlers' array, SQS payload is passed to default handler.
71116

72-
Add `sqs-json` connection to your config/queue.php, Ex:
117+
Register your webhooks with your Laravel application.
118+
119+
Add `sqs-json` connection to your config/queue.php, Example:
73120

74121
```php
75122
[
@@ -91,7 +138,9 @@ In your .env file, choose sqs-json as your new default queue driver:
91138
QUEUE_DRIVER=sqs-json
92139
```
93140

94-
Dispatching to SQS
141+
Enjoy seamless, reliable, and scalable webhook processing!
142+
143+
## Dispatching to SQS
95144

96145
If you plan to push plain messages from Laravel, you can rely on DispatcherJob:
97146

@@ -183,6 +232,12 @@ class SqsHandlerJob extends Job
183232
}
184233
```
185234

235+
Note:
236+
237+
Ensure that your Laravel application is configured with the necessary AWS credentials and permissions to interact with SQS.
238+
239+
Enhance your Laravel application's webhook processing capabilities with the Laravel Webhook Queue Reader. Efficient, reliable, and designed for optimal performance!
240+
186241
For more information about AWS SQS check [offical docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-queue-parameters.html).
187242

188243
## Testing

0 commit comments

Comments
 (0)