Skip to content

Commit

Permalink
replaced png graphs with mermaid js
Browse files Browse the repository at this point in the history
  • Loading branch information
niklastreml committed Nov 10, 2022
1 parent 42bffda commit 784b1e2
Showing 1 changed file with 80 additions and 2 deletions.
82 changes: 80 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,88 @@ Canary Bot: A single instance running on a dedicated system

Canary Mesh: Multiple Canary Bots connected to each other. Every Canary Bot manages its own mesh instance, knowing about the bots that are accessible by itself.


### Canary Mesh startup

![Canary Mesh](mesh.drawio.png)
<!-- ![Canary Mesh](mesh.drawio.png) -->

1. First node in mesh

```mermaid
flowchart LR
subgraph graph [" "]
ob(owl-bot)
ob--joinMesh routine to target-->ob
end
```
2. Second node joins
```mermaid
flowchart LR
subgraph graph [" "]
gb(goose-bot)
ob(owl-bot)
ob --joins mesh--> gb
gb --joins mesh--> ob
end
```
One bot joins mesh of the other; depends on who is faster
3. Mesh created
```mermaid
flowchart LR
subgraph graph [" "]
gb(goose-bot)
ob(owl-bot)
ob <--> gb
end
```
All routines start: mesh functionality, measurement functionalities
4. Third node joins
```mermaid
flowchart TB
subgraph graph [" "]
gb(goose-bot)
eb(eagle-bot)
ob(owl-bot)
ob <--> gb
eb --joinMesh--> gb
gb --send I-Am info--> eb
end
```
5. Sending discovery
```mermaid
flowchart LR
subgraph graph [" "]
gb(goose-bot)
eb(eagle-bot)
ob(owl-bot)
gb --send discovery--> ob
gb <--> ob
gb <--> eb
end
```
6. Mesh expanded
```mermaid
flowchart LR
subgraph graph [" "]
gb(goose-bot)
eb(eagle-bot)
ob(owl-bot)
gb <-->eb
eb <-->ob
ob <-->gb
end
```
### CLI options
Expand Down

0 comments on commit 784b1e2

Please sign in to comment.