Skip to content

Commit 6bb8256

Browse files
chore: update readme with sonarcloud badges and usage section
1 parent 21ab3e5 commit 6bb8256

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

Diff for: README.md

+19-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# Digital Twins Event Gateway
22

33
![workflow status](https://github.com/smartoperatingblock/dt-event-gateway/actions/workflows/build-and-deploy.yml/badge.svg)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=plastic)](https://opensource.org/licenses/MIT)
5+
![Version](https://img.shields.io/github/v/release/smartoperatingblock/dt-event-gateway?style=plastic)
6+
7+
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_dt-event-gateway&metric=bugs)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_dt-event-gateway)
8+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_dt-event-gateway&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_dt-event-gateway)
9+
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_dt-event-gateway&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_dt-event-gateway)
10+
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=SmartOperatingBlock_dt-event-gateway&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=SmartOperatingBlock_dt-event-gateway)
511

612
The Event Gateway between Digital Twins and Microservices.
713

8-
It's responsible to consume events from **Azure Digital Twins** through **Azure SignalR** service and to propagate them to application microservices through the **Kafka Event Broker**.
14+
It's responsible to consume events from **Azure Digital Twins** through **Azure SignalR** service and to propagate them to application microservices through a **Kafka Event Broker**.
15+
16+
## Usage
17+
1. Provide a `.env` file with the following variables:
18+
- BOOTSTRAP_SERVER_URL
19+
- SCHEMA_REGISTRY_URL
20+
- SIGNALR_CONNECTION_STRING
21+
2. Run the container with the following command:\
22+
`docker run ghcr.io/smartoperatingblock/dt-event-gateway:1.2.1`
23+
924

1025
## Documentation
11-
- Checkout the latest events AsyncAPI documentation [here](https://smartoperatingblock.github.io/dt-event-gateway/documentation/asyncapi-doc)
12-
- Checkout the latest project documentation [here](https://smartoperatingblock.github.io/dt-event-gateway/documentation/code-doc)
26+
- Check out the *AsyncAPI* documentation [here](https://smartoperatingblock.github.io/dt-event-gateway/documentation/asyncapi-doc)
27+
- Check out the latest code documentation [here](https://smartoperatingblock.github.io/dt-event-gateway/documentation/code-doc)
1328

1429
---
1530

0 commit comments

Comments
 (0)