Skip to content

Commit cea7a33

Browse files
author
palPalani
committed
Improved readme with more informations
1 parent 5af2e2c commit cea7a33

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

CHANGELOG.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
All notable changes to `laravel-sqs-queue-json-reader` will be documented in this file.
44

5-
## 1.0.0 - 202X-XX-XX
5+
## 0.1.1 - 2021-01-17
6+
7+
- Updated CS tools
8+
9+
## 0.1.0 - 2021-01-15
610

711
- initial release

README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
[![Total Downloads](https://img.shields.io/packagist/dt/palpalani/laravel-sqs-queue-json-reader.svg?style=flat-square)](https://packagist.org/packages/palpalani/laravel-sqs-queue-json-reader)
66

77

8-
Custom SQS queue reader for Laravel that supports JSON payloads.
9-
Out of the box, Laravel expects SQS messages to be generated in a
10-
specific format - format that includes job handler class and a serialized job.
8+
Custom SQS queue reader for Laravel that supports plain JSON payloads.
9+
Laravel expects SQS messages to be generated in a
10+
specific format that includes job handler class and a serialized job.
1111

12-
But in certain cases you may want to parse messages from third party
12+
But in certain cases you may want to parse messages from 3rd party
1313
applications, custom JSON messages and so on.
1414

1515
## Installation
@@ -96,16 +96,19 @@ class ExampleController extends Controller
9696
}
9797
}
9898
```
99-
This will push the following JSON object to SQS:
99+
Above code will push the following JSON object to SQS queue:
100100

101101
```json
102-
{"job":"App\\Jobs\\SqsHandler@handle","data":{"music":"Sample message","time":1464411642}}
102+
{"job":"App\\Jobs\\SqsHandler@handle","data":{"music":"Sample SQS message","time":1464511672}}
103103
```
104104

105-
'job' field is not used, actually. It's just kept for compatibility.
105+
'job' field is not used, actually. It's just kept for compatibility with Laravel
106+
Framework.
106107

107-
Receiving from SQS
108-
If a third-party application is creating custom-format JSON messages, just add a
108+
### Receiving from SQS
109+
110+
If a 3rd-party application or API Gateway to SQS implementation is creating
111+
custom-format JSON messages, just add a
109112
handler in the config file and implement a handler class as follows:
110113

111114
```php

0 commit comments

Comments
 (0)