docs: Design diagram

learn-video · Jan 12, 2024 · 882f348 · 882f348
1 parent add43f8
commit 882f348
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,14 @@ Generate mosaic videos from live inputs.
 
 It uses ffmpeg to capture the video and position them in a grid.
 
+## Design
+
+The project has two main components:
+* Worker: a Go process that receives the inputs and generates the mosaic;
+* Storage backend: HTTP server that receives the mosaic through HTTP and stores it on S3.
+
+![Mosaic Video design](docs/static/mosaic_design.png)
+
 ## Features
 
 * Generate mosaic from multiple video inputs;

diff --git a/docs/static/mosaic_design.png b/docs/static/mosaic_design.png