gh-3 modify readme

Author: Vaibhav Bhalla

README.md

@@ -1,3 +1,30 @@
+<p align="center">
+  <a href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" width="180" alt="ARC Logo" /></a>
+</p>
+
+  ARC by SourceFuse is an open-source Rapid Application Development framework for developing cloud-native enterprise applications, utilizing prebuilt microservices and standardized architectures for deployment on private and public clouds.
+</p>
+
+<p align="center">
+<a href="https://sonarcloud.io/summary/new_code?id=sourcefuse_loopback4-message-bus-queue-connector" target="_blank">
+<img alt="Sonar Quality Gate" src="https://img.shields.io/sonar/quality_gate/sourcefuse_loopback4-s3?server=https%3A%2F%2Fsonarcloud.io">
+</a>
+<a href="https://app.snyk.io/org/ashishkaushik/reporting?context[page]=issues-detail&project_target=%255B%2522sourcefuse%252Floopback4-message-bus-queue-connector%2522%255D&project_origin=%255B%2522github%2522%255D&issue_status=%255B%2522Open%2522%255D&issue_by=Severity&table_issues_detail_cols=SEVERITY%257CSCORE%257CCVE%257CCWE%257CPROJECT%257CEXPLOIT%2520MATURITY%257CCOMPUTED%2520FIXABILITY%257CINTRODUCED%257CSNYK%2520PRODUCT&tableRowsPerPage=10&v=1&table_issues_detail_sort=SCORE%2520DESC">
+<img alt="Synk Status" src="https://img.shields.io/badge/SYNK_SECURITY-MONITORED-GREEN">
+</a>
+<a href="https://github.com/sourcefuse/loopback4-message-bus-queue-connector/graphs/contributors" target="_blank">
+<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sourcefuse/loopback4-s3">
+</a>
+<a href="https://www.npmjs.com/package/loopback4-message-bus-queue-connector" target="_blank">
+<img alt="downloads" src="https://img.shields.io/npm/dw/loopback4-s3.svg">
+</a>
+<a href="https://github.com/sourcefuse/loopback4-message-bus-queue-connector/blob/master/LICENSE">
+<img src="https://img.shields.io/github/license/sourcefuse/loopback4-s3.svg" alt="License" />
+</a>
+<a href="https://loopback.io/" target="_blank">
+<img alt="Powered By LoopBack 4" src="https://img.shields.io/badge/Powered%20by-LoopBack 4-brightgreen" />
+</a>
+
 # Message bus queue connectors
 
 This is the package for the message bus queue connectors component for LoopBack 4 applications.
@@ -12,7 +39,6 @@ Install EventStreamConnectorComponent using `npm`;
 ```sh
 $ [npm install | yarn add] @sourceloop/message-bus-queue-connectors
 ```
-
 ## Flow Diagram
 
 <img width="659" alt="Screenshot 2025-06-06 at 10 53 06 AM" src="https://github.com/user-attachments/assets/baf1bcaa-5f67-44bb-a01a-b8d1c41644bc" />
@@ -23,7 +49,9 @@ Configure and load EventStreamConnectorComponent in the application constructor
 as shown below.
 
 ```ts
-import {EventStreamConnectorComponent} from '@sourceloop/message-bus-queue-connectors';
+import {
+  EventStreamConnectorComponent
+} from '@sourceloop/message-bus-queue-connectors';
 
 // ...
 export class MyApplication extends BootMixin(
@@ -46,7 +74,7 @@ To use SQS as their message queue, bind its required config and connector compon
 import {
   SQSConnector,
   SQSBindings,
-  EventStreamConnectorComponent,
+  EventStreamConnectorComponent
 } from '@sourceloop/message-bus-queue-connectors';
 
 // ...
@@ -155,10 +183,10 @@ const config = {
 
 ## Integration
 
-@sourceloop/message-bus-queue-connectors provides a decorator '@producer()' that can be used to access the producer of each msg queue. It expects one arguement defining the type of queue, of which producer u want to use. like
+ @sourceloop/message-bus-queue-connectors provides a decorator '@producer()' that can be used to access the producer of each msg queue. It expects one arguement defining the type of queue, of which producer u want to use. like
 
-```ts
-@injectable({scope: BindingScope.TRANSIENT})
+ ```ts 
+ @injectable({scope: BindingScope.TRANSIENT})
 export class EventConnector implements IEventConnector<PublishedEvents> {
   constructor(
     @producer(QueueType.EventBridge)
@@ -170,55 +198,48 @@ export class EventConnector implements IEventConnector<PublishedEvents> {
   ) {}
 
   // rest of implementation
+
 }
-```
+ ```
 
-Producer provider two ways of sending events - single event at a time and multiple event at a time.
+ Producer provider two ways of sending events - single event at a time and multiple event at a time.
 
-```ts
-export type Producer<Stream extends AnyObject = AnyObject> = {
-  send: <Event extends keyof Stream>(
-    data: Stream[Event],
-    topic?: Event,
-  ) => Promise<void>;
-  sendMultiple: <Event extends keyof Stream>(
-    data: Stream[Event][],
-    topic?: Event,
-  ) => Promise<void>;
+ ```ts
+ export type Producer<Stream extends AnyObject = AnyObject> = {
+    send: <Event extends keyof Stream>(data: Stream[Event], topic?: Event) => Promise<void>;
+    sendMultiple: <Event extends keyof Stream>(data: Stream[Event][], topic?: Event) => Promise<void>;
 };
-```
+ ```
 
 It provides '@consumer' decorator to make a service as consumer. consumer needs to follow an interface.
 
 ```ts
-export interface IConsumer<
-  Stream extends AnyObject,
-  Event extends keyof Stream,
-> {
-  event: Event;
-  queue: QueueType;
-  handle(data: Stream[Event]): Promise<void>;
+export interface IConsumer<Stream extends AnyObject, Event extends keyof Stream> {
+    event: Event;
+    queue: QueueType;
+    handle(data: Stream[Event]): Promise<void>;
 }
 ```
 
-and can be used as
+and can be used as 
 
 ```ts
 import {
   IConsumer,
   QueueType,
   consumer,
 } from '@sourceloop/message-bus-queue-connectors';
-import {OrchestratorStream, EventTypes, ProvisioningInputs} from '../../types';
+import { OrchestratorStream, EventTypes, ProvisioningInputs } from '../../types';
 
 @consumer
 export class TenantProvisioningConsumerForEventSQS
   implements IConsumer<OrchestratorStream, EventTypes.TENANT_PROVISIONING>
 {
-  constructor() {}
+  constructor(
+  ) {}
   event: EventTypes.TENANT_PROVISIONING = EventTypes.TENANT_PROVISIONING;
   queue: QueueType = QueueType.SQS;
-  async handle(data: ProvisioningInputs): Promise<void> {
+  async handle(data: ProvisioningInputs): Promise<void> {    
     console.log(`SQS: ${this.event} Event Recieved ` + JSON.stringify(data));
     return;
   }