diff options
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..f46f322d --- /dev/null +++ b/examples/README.md @@ -0,0 +1,15 @@ +# Mitmproxy Scripting API + +Mitmproxy has a powerful scripting API that allows you to control almost any aspect of traffic being +proxied. In fact, much of mitmproxy’s own core functionality is implemented using the exact same API +exposed to scripters (see [mitmproxy/addons](../mitmproxy/addons)). + +This directory contains some examples of the scripting API. We recommend to start with the +ones in [simple/](./simple). + +| :warning: | If you are browsing this on GitHub, make sure to select the git tag matching your mitmproxy version. | +|------------|------------------------------------------------------------------------------------------------------| + + +Some inline scripts may require additional dependencies, which can be installed using +`pip install mitmproxy[examples]`.
\ No newline at end of file |