diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2016-11-21 02:16:20 +0100 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2016-11-21 02:28:10 +0100 |
| commit | 9af8f4bb31c94a25780a4189bffa406906249626 (patch) | |
| tree | cf52f1c312b7bac3d83d796d6b03bb33b4556f26 /examples/README.md | |
| parent | f74e561524d04c93cd7953f34e78ebe67eaa58a8 (diff) | |
| download | mitmproxy-9af8f4bb31c94a25780a4189bffa406906249626.tar.gz mitmproxy-9af8f4bb31c94a25780a4189bffa406906249626.tar.bz2 mitmproxy-9af8f4bb31c94a25780a4189bffa406906249626.zip | |
organize examples
This commit is largely based on work by Thiago Arrais (@thiagoarrais)
and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their
PR reasonably merged onto the latest master, so I reapplied their changes
manually here and did some further improvements on that.
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 |