aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--web/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/web/README.md b/web/README.md
index ae558bd6..7b412a5f 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`