aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLucas Ramage <ramage.lucas@protonmail.com>2020-05-18 14:21:23 -0400
committerGitHub <noreply@github.com>2020-05-18 14:21:23 -0400
commit78545628834ee7cd346a05e5bd06869c2b22a095 (patch)
tree2b321b0661b78fff7c87c8915686710eb7997c58
parent67372d26ae213ca083c75ecaf5752c49a6c0ef17 (diff)
downloadmitmproxy-78545628834ee7cd346a05e5bd06869c2b22a095.tar.gz
mitmproxy-78545628834ee7cd346a05e5bd06869c2b22a095.tar.bz2
mitmproxy-78545628834ee7cd346a05e5bd06869c2b22a095.zip
Document mitmweb architecture
Bug: https://github.com/mitmproxy/mitmproxy/issues/3925
-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`