Skip to content

Commit

Permalink
Use subgraphs to clarify which modules are cross-platform
Browse files Browse the repository at this point in the history
  • Loading branch information
fwcd committed Aug 3, 2024
1 parent 8115b1d commit 778430e
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A distributed chat messenger that uses Bluetooth LE mesh networks.
The project consists of the following components:

* `DistributedChatKit`: The abstract application, platform-independent, transport-independent (uses interface for broadcasting/receiving messages)
* `DistributedChatApp`: The iOS implementation, uses Bluetooth LE as transport, does **not** require a server
* `DistributedChatApp`: The iOS/macOS implementation, uses Bluetooth LE as transport, does **not** require a server
* `DistributedChatCLI`: The CLI implementation, uses either HTTP/WebSockets as transport with the simulation server or Bluetooth LE (WIP)
* `DistributedChatSimulationProtocol`: The high-level JSON-based protocol used between CLI and simulation server
* `DistributedChatSimulationServer`: The companion server for the CLI, relays messages between connected CLI nodes, provides web-interface for configuring links between nodes
Expand All @@ -42,10 +42,14 @@ The dependency graph between these packages looks like this:

```mermaid
flowchart BT
DistributedChatApp --> DistributedChatKit
DistributedChatCLI --> DistributedChatKit
DistributedChatCLI --> DistributedChatSimulationProtocol
DistributedChatSimulationServer --> DistributedChatSimulationProtocol
subgraph cross-platform
DistributedChatCLI --> DistributedChatKit
DistributedChatCLI --> DistributedChatSimulationProtocol
DistributedChatSimulationServer --> DistributedChatSimulationProtocol
end
subgraph "Apple platforms"
DistributedChatApp --> DistributedChatKit
end
```

## Building and Running
Expand Down

0 comments on commit 778430e

Please sign in to comment.