Skip to content

Commit ac745e3

Browse files
chore: update README.md
1 parent 3a9c9e5 commit ac745e3

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,27 @@
1010
[![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)
1111

1212
The Event Gateway between Digital Twins and Microservices.
13-
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**.
13+
- Consume events from <strong>Azure Digital Twins</strong> through <strong>Azure SignalR</strong> service.
14+
- Propagate events to application microservices through a <strong>Kafka Event Broker</strong>.
1515

1616
## Usage
1717
1. Provide a `.env` file with the following variables:
1818
- BOOTSTRAP_SERVER_URL
1919
- SCHEMA_REGISTRY_URL
2020
- SIGNALR_CONNECTION_STRING
2121
2. Run the container with the following command:\
22-
`docker run ghcr.io/smartoperatingblock/dt-event-gateway:1.2.1`
22+
```bash
23+
docker run ghcr.io/smartoperatingblock/dt-event-gateway:1.2.1
24+
```
2325

2426

2527
## Documentation
28+
- Visit the website here [here](https://smartoperatingblock.github.io/dt-event-gateway)
2629
- 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)
30+
- Check out the code documentation [here](https://smartoperatingblock.github.io/dt-event-gateway/documentation/code-doc)
2831

29-
---
32+
<hr>
3033

31-
![](https://raw.githubusercontent.com/SmartOperatingBlock/documentation/main/imgs/dt-event-gateway-schema.svg)
34+
<p align="center">
35+
<img src="https://raw.githubusercontent.com/SmartOperatingBlock/documentation/main/imgs/dt-event-gateway-schema.svg" width=700px height=300px/>
36+
</p>

0 commit comments

Comments
 (0)