Skip to content

Commit

Permalink
fix: README images (#1)
Browse files Browse the repository at this point in the history
Signed-off-by: Jeremy HERGAULT <[email protected]>
  • Loading branch information
reneca authored Jun 28, 2024
1 parent 46a874e commit 6b9ab4a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ The goal of this project is to provide a flexible and scalable platform for deve
## Legend

ProSA components are illustrated:
- Main: [![main](https://raw.githubusercontent.com/worldline/prosa/main/assets/main.svg){width=26}](https://docs.rs/prosa/latest/prosa/core/main/ "main")
- TVF: [![tvf](https://raw.githubusercontent.com/worldline/prosa/main/assets/tvf.svg){width=26}](https://docs.rs/prosa_utils/latest/prosa_utils/msg/tvf/ "tvf")
- Processor: [![processor](https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg){width=26}](https://docs.rs/prosa/latest/prosa/core/proc/ "processor")
- Settings: [![settings](https://raw.githubusercontent.com/worldline/prosa/main/assets/settings.svg){width=26}](https://docs.rs/prosa/latest/prosa/core/settings/ "settings")
- Adaptor: [![adaptor](https://raw.githubusercontent.com/worldline/prosa/main/assets/adaptor.svg){width=26}](https://docs.rs/prosa/latest/prosa/core/adaptor/ "adaptor")
- Main: [<img alt="main" src="https://raw.githubusercontent.com/worldline/prosa/main/assets/main.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/main/ "main")
- TVF: [<img alt="tvf" src="https://raw.githubusercontent.com/worldline/prosa/main/assets/tvf.svg" width="26">](https://docs.rs/prosa_utils/latest/prosa_utils/msg/tvf/ "tvf")
- Processor: [<img alt="processor" src="https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/proc/ "processor")
- Settings: [<img alt="settings" src="https://raw.githubusercontent.com/worldline/prosa/main/assets/settings.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/settings/ "settings")
- Adaptor: [<img alt="adaptor" src="https://raw.githubusercontent.com/worldline/prosa/main/assets/adaptor.svg" width="26">](https://docs.rs/prosa/latest/prosa/core/adaptor/ "adaptor")


## Service approach
Expand All @@ -24,9 +24,9 @@ To do so, ProSA is built around a _service bus_ that can be local or distributed
Around the service bus, there are gravitating processors that offer or consume services.
``` mermaid
flowchart LR
proc1("<img alt='processor' title='processor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg'; width='20' />")
proc2("<img alt='processor' title='processor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg'; width='20' />")
bus(("<img alt='main' title='main' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/main.svg'; width='20' />"))
proc1(Processor)
proc2(Processor)
bus((Main))
proc1 <--> bus
bus <--> proc2
```
Expand All @@ -36,9 +36,9 @@ ProSA processors can be autonomous or built to connect external systems to make
``` mermaid
flowchart LR
ext(External System)
adapt("<img alt='adaptor' title='adaptor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/adaptor.svg'; width='20' />")
proc("<img alt='processor' title='processor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg'; width='20' />")
bus(("<img alt='main' title='main' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/main.svg'; width='20' />"))
adapt(Adaptor)
proc(Processor)
bus((Main))
ext <-- Protocol Exchange --> adapt
subgraph Processor
adapt <-- protocol adaptation --> proc
Expand All @@ -53,11 +53,11 @@ Everything you need to know about ProSA components is describe in the [Docs.rs](

``` mermaid
flowchart LR
main(("<img alt='main' title='main' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/main.svg'; width='20' />"))
tvf(["<img alt='tvf' title='tvf' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/tvf.svg'; width='20' />"])
proc("<img alt='processor' title='processor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/proc.svg'; width='20' />")
settings("<img alt='settings' title='settings' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/settings.svg'; width='20' />")
adapt("<img alt='adaptor' title='adaptor' src='https://raw.githubusercontent.com/worldline/prosa/main/assets/adaptor.svg'; width='20' />")
main((Main))
tvf([TVF])
proc(Processor)
settings(Settings)
adapt(Adaptor)
click main "https://docs.rs/prosa/latest/prosa/core/main/" "Main"
click tvf "https://docs.rs/prosa_utils/latest/prosa_utils/msg/tvf/" "TVF"
click proc "https://docs.rs/prosa/latest/prosa/core/proc/" "Processor"
Expand Down
1 change: 1 addition & 0 deletions prosa/README.md

0 comments on commit 6b9ab4a

Please sign in to comment.