From 2b126c682dc11d7e0d2d4aa2a6764edb88f1997d Mon Sep 17 00:00:00 2001
From: Andre Weber <andre.weber3@etas.com>
Date: Fri, 10 Jan 2025 14:30:36 +0100
Subject: [PATCH] docs: Add Documentation to README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3dc320a..f9958f5 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,41 @@ The KUKSA Java SDK allows you to interact with [VSS data](https://covesa.github.
 from the [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker/tree/main/)
 within a Java Application. The main functionality consists of fetching, updating and subscribing to VSS data.
 
+Currently the following protocols are supported:
+- kuksa.val.v1
+- kuksa.val.v2
+
+## kuksa.val.v1
+
+You can interact with the Databroker using the kuksa.val.v1 interface by using the 
+org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnector class.
+
+After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnection:
+- subscribe(SubscribeRequest, VssPathListener)
+- unsubscribe(SubscribeRequest, VssPathListener)
+- subscribe(VssNodeSubscribeRequest<T>, VssNodeListener<T>)
+- unsubscribe(VssNodeSubscribeRequest<T>, VssNodeListener<T>)
+- fetch(FetchRequest): GetResponse
+- fetch(VssNodeFetchRequest<T>): T
+- update(UpdateRequest): SetResponse
+- update(VssNodeUpdateRequest<T>): VssNodeUpdateResponse
+
+## kuksa.val.v2
+
+You can interact with the Databroker using the kuksa.val.v1 interface by using the
+org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectorV2 class.
+
+After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectionV2:
+- fetchValue(FetchValueRequestV2): GetValueResponse
+- fetchValues(FetchValuesRequestV2): GetValuesResponse
+- subscribeById(SubscribeByIdRequestV2): Flow<SubscribeByIdResponse>
+- subscribe(SubscribeRequestV2): Flow<SubscribeResponse>
+- actuate(ActuateRequestV2): ActuateResponse
+- batchActuate(BatchActuateRequestV2): BatchActuateResponse
+- listMetadata(ListMetadataRequestV2): ListMetadataResponse
+- publishValue(PublishValueRequestV2): PublishValueResponse
+- openProviderStream(StreamObserver<OpenProviderStreamResponse>): StreamObserver<OpenProviderStreamRequest>
+
 ## Integration
 
 *app/build.gradle.kts*
@@ -23,8 +58,7 @@ implementation("org.eclipse.kuksa:kuksa-java-sdk:<VERSION>")
 The latest release version can be seen [here](https://github.com/eclipse-kuksa/kuksa-java-sdk/releases).
 
 
-See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md) for
-additional integration options.
+See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md) for additional integration options.
 
 ### Maven Central