Skip to content

Commit 603373b

Browse files
RaymundoZasiri-varmaartur-ciocanucicoyle
authored andcommitted
docs: add architecture diagram to README (dapr#1549)
* Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <siri.varma@outlook.com> Co-authored-by: artur-ciocanu <artur.ciocanu@gmail.com> Co-authored-by: Cassie Coyle <cassie.i.coyle@gmail.com> Signed-off-by: salaboy <Salaboy@gmail.com>
1 parent 69b2ccd commit 603373b

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ This is the Dapr SDK for Java, including the following features:
1313

1414
## Getting Started
1515

16+
### Architecture Overview
17+
18+
The diagram below shows how a Java application interacts with the Dapr runtime through the Java SDK:
19+
20+
```mermaid
21+
flowchart LR
22+
A[End User Application] -->|HTTP or gRPC| B[Dapr Java SDK]
23+
B -->|Dapr API calls| C[Dapr Sidecar]
24+
C -->|Components| D[State Stores, Pub/Sub, Services, etc.]
25+
26+
%% Optional grouping for clarity
27+
subgraph R[Dapr Runtime]
28+
C
29+
D
30+
end
31+
```
32+
33+
For the full list of available APIs, see the [Dapr API reference](https://docs.dapr.io/reference/api/)
34+
1635
### Pre-Requisites
1736
* SDKMAN! installed (recommended):
1837
* [SDKMAN!](https://sdkman.io)
@@ -278,4 +297,4 @@ Once the project has been imported, the individual tests can be run normally as
278297
279298
> Sometimes when the `sdk-tests` project does not build correctly, try `File > Invalidate Caches...` and try restarting IntelliJ.
280299
281-
You should be able to set breakpoints and Debug the test directly from IntelliJ itself as seen from the above image.
300+
You should be able to set breakpoints and Debug the test directly from IntelliJ itself as seen from the above image.

0 commit comments

Comments
 (0)