docs: add a connection vs. protocols flowchart

Signed-off-by: ljedrz <[email protected]>
ljedrz · Apr 24, 2023 · 9fab1ed · 9fab1ed
1 parent 63d7d21
commit 9fab1ed
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/assets/connection_lifetime.png b/assets/connection_lifetime.png
diff --git a/src/protocols/mod.rs b/src/protocols/mod.rs
@@ -1,6 +1,9 @@
 //! Opt-in protocols available to the node; each protocol is expected to spawn its own task that runs throughout the
 //! node's lifetime and handles a specific functionality. The communication with these tasks is done via dedicated
 //! handler objects.
+//!
+//! A flowchart detailing how the protocols interact with a connection during its lifetime can be seen
+//! [here](https://github.com/ljedrz/pea2pea/tree/master/assets/connection_lifetime.png).
 
 use std::{io, net::SocketAddr};