chore: update README

README.md

@@ -1,2 +1,26 @@
-# azuredt-wodt-adapter-azurefunction
-The Azure Function to deploy in the Azure pipeline to work with the azure-wodt-adapter.
+# Azure Function for Azure Digital Twins WoDT adapter
+![workflow status](https://github.com/Web-of-Digital-Twins/azuredt-wodt-adapter-azurefunction/actions/workflows/build-and-deploy.yml/badge.svg)
+[![License: Apache License](https://img.shields.io/badge/License-Apache_License_2.0-yellow.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+![Version](https://img.shields.io/github/v/release/Web-of-Digital-Twins/azuredt-wodt-adapter-azurefunction?style=plastic)
+
+The Azure Function to deploy in the Azure pipeline to work with the azuredt-wodt-adapter.
+
+## Architecture
+The minimal pipeline to make it works is composed by four services:
+1. [**Azure Digital Twins**](https://learn.microsoft.com/en-us/azure/digital-twins/): it manages the Digital Twins to adapt.
+2. [**Azure Event Grid**](https://learn.microsoft.com/en-us/azure/event-grid/): it routes events from Azure Digital Twins along the pipeline.
+3. [***Azure Function***](https://learn.microsoft.com/en-us/azure/azure-functions/): it is the function of interest for this repo. It has the responsibility of creating a snapshot of the DT, starting from the event. The snapshot is then sent to the azure-wodt-adapter via the *Azure SignalR* service.
+4. [**Azure SignalR**](https://learn.microsoft.com/en-us/azure/azure-signalr/): it is used to make data observable.
+
+In the following, an image depicting this architecture:
+<center>
+    <img src="./imgs/prototype_adt_dt.jpg" alt="azure architecture" width="50%"/>
+</center>
+
+## Function Configuration
+It requires the following environmental variables:
+- `ADT_SERVICE_URL`: the *Azure Digital Twins* instance url.
+- `AzureSignalRConnectionString`: the *Azure SignalR* connection string.
+
+## Useful resources
+- [`azuredt-wodt-adapter`](https://github.com/Web-of-Digital-Twins/azuredt-wodt-adapter): the middleware that used in combination with this Azure Function enable to expose ADT DTs as WoDT Digital Twins.