feat(tinder): Add doc file

berty · Mar 6, 2020 · 452a2e6 · 452a2e6
1 parent abb751e
commit 452a2e6
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/go/internal/tinder/doc.go b/go/internal/tinder/doc.go
@@ -0,0 +1,17 @@
+package tinder
+
+// Tinder service is a multi-driver service backed by a cache
+//
+//                   ┌───────────────────────────────────────────────────┐
+//                   │ Tinder                                            │        ┌───────────────────────┐
+// ┌───────────────┐ │                                                   │  ┌────▶│    Driver DHT Ipfs    │
+// │   Advertise   │▶┼───┐     ┌────────────────┐                        │  │     └───────────────────────┘
+// └───────────────┘ │   │     │ Backoff Cache  │                        │  │     ┌───────────────────────┐
+// ┌───────────────┐ │   ├────▶│    Discover    │──┐   ┌───────────────┐ │  ├────▶│   Driver DHT Berty    │
+// │   FindPeers   │▶┼───┘     └────────────────┘  │   │Driver Manager │ │  │     └───────────────────────┘
+// └───────────────┘ │              ┌──────────────┴──▶│ (MultiDriver) │─┼──┤     ┌───────────────────────┐
+// ┌───────────────┐ │              │                  └───────────────┘ │  ├────▶│Driver RendezVousPoint │
+// │  Unregister   │▶┼──────────────┘                                    │  │     └───────────────────────┘
+// └───────────────┘ │                                                   │  │     ┌───────────────────────┐
+//                   │                                                   │  └────▶│Driver Local (ble/mdns)│
+//                   └───────────────────────────────────────────────────┘        └───────────────────────┘