From 78545628834ee7cd346a05e5bd06869c2b22a095 Mon Sep 17 00:00:00 2001
From: Lucas Ramage <ramage.lucas@protonmail.com>
Date: Mon, 18 May 2020 14:21:23 -0400
Subject: [PATCH] Document mitmweb architecture

Bug: https://github.com/mitmproxy/mitmproxy/issues/3925
---
 web/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/web/README.md b/web/README.md
index ae558bd6e..7b412a5f1 100644
--- a/web/README.md
+++ b/web/README.md
@@ -6,3 +6,11 @@ and activate your virtualenv environment before proceeding.**
 - Run `yarn` to install dependencies
 - Run `yarn run gulp` to start live-compilation.
 - Run `mitmweb` and open http://localhost:8081/
+
+## Architecture
+
+There are two components:
+
+- Server: [`mitmproxy/tools/web`](../mitmproxy/tools/web)
+
+- Client: `web`