From 5c715213105c073e41db5628cca2fcea98389876 Mon Sep 17 00:00:00 2001 From: Rob Date: Tue, 7 Jan 2025 16:48:32 -0500 Subject: [PATCH] better readme example --- README.md | 3 +++ example.svg | 2 ++ 2 files changed, 5 insertions(+) create mode 100644 example.svg diff --git a/README.md b/README.md index ed51f92..5099e4e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ The Push-CDN is a distributed and fault tolerant messaging system built to accelerate peer-to-peer networks. It does this by keeping track of the network topology, which enables it to route messages more efficiently than traditional gossip-based protocols. +![Example message flow](example.svg) +_Bob wants to broadcast an identical message to two of his close friends, Alice and Charlie. The CDN knows where each friend is located, so the message is routed to them directly and no other users (like Dan) receive the message as a consequence._ + ## Feature highlights - Fast, reliable, and efficient - Support for both publish-subscribe and direct messaging models diff --git a/example.svg b/example.svg new file mode 100644 index 0000000..76df1d3 --- /dev/null +++ b/example.svg @@ -0,0 +1,2 @@ +BrokerBobBrokerAliceBrokerCharlieBrokerDan \ No newline at end of file