diff options
author | Maximilian Hils <git@maximilianhils.com> | 2014-09-14 15:22:24 +0200 |
---|---|---|
committer | Maximilian Hils <git@maximilianhils.com> | 2014-09-14 15:22:24 +0200 |
commit | 80af3589e244b7d772ab649462f1c27070d15284 (patch) | |
tree | 3bdabe0e9bc0352d756d201c6cae5202445e7cb6 | |
parent | be0996da3533b70be5841da082780e3e0c99bfd6 (diff) | |
download | mitmproxy-80af3589e244b7d772ab649462f1c27070d15284.tar.gz mitmproxy-80af3589e244b7d772ab649462f1c27070d15284.tar.bz2 mitmproxy-80af3589e244b7d772ab649462f1c27070d15284.zip |
docs: make sure that inline script devs don't miss the examples
-rw-r--r-- | doc-src/scripting/inlinescripts.html | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc-src/scripting/inlinescripts.html b/doc-src/scripting/inlinescripts.html index eef4e440..2c3e0d6f 100644 --- a/doc-src/scripting/inlinescripts.html +++ b/doc-src/scripting/inlinescripts.html @@ -21,6 +21,12 @@ We can now run this script using mitmdump or mitmproxy as follows: The new header will be added to all responses passing through the proxy. +## Example Scripts + +mitmproxy comes with a variety of example inline scripts, which demonstrate +many basic tasks. We encourage you to either browse them locally or in our +[GitHub repo](https://github.com/mitmproxy/mitmproxy/tree/master/examples). + ## Events @@ -129,8 +135,9 @@ The main classes you will deal with in writing mitmproxy scripts are: </tr> </table> -The canonical API documentation is the code. You can view the API documentation -using pydoc (which is installed with Python by default), like this: +The canonical API documentation is the code, which you can browse locally or in our +[GitHub repo](https://github.com/mitmproxy/mitmproxy). +You can view the API documentation using pydoc (which is installed with Python by default), like this: <pre class="terminal"> > pydoc libmproxy.protocol.http.HTTPRequest |