aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2020-06-12 13:18:49 +0200
committerGitHub <noreply@github.com>2020-06-12 13:18:49 +0200
commit31a6f60e4597b695d3ad03d7d98eb4fd6c4d5858 (patch)
treed87c70c5753aeb9f8394592be960a0c989ddccc4
parentc93d00bd7fe99fd86205d76c0bf22c6afacf0a66 (diff)
parent78545628834ee7cd346a05e5bd06869c2b22a095 (diff)
downloadmitmproxy-31a6f60e4597b695d3ad03d7d98eb4fd6c4d5858.tar.gz
mitmproxy-31a6f60e4597b695d3ad03d7d98eb4fd6c4d5858.tar.bz2
mitmproxy-31a6f60e4597b695d3ad03d7d98eb4fd6c4d5858.zip
Merge pull request #4006 from oxr463/patch-2
Document mitmweb architecture
-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`