aboutsummaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.mkd b/README.mkd
index 764c5a36..e46ca9da 100644
--- a/README.mkd
+++ b/README.mkd
@@ -1,12 +1,13 @@
-__mitmproxy__ is an SSL-capable, intercepting HTTP proxy. It provides a console
-interface that allows traffic flows to be inspected and edited on the fly.
+__mitmproxy__ is an SSL-capable man-in-the-middle proxy for HTTP. It provides a
+console interface that allows traffic flows to be inspected and edited on the
+fly.
__mitmdump__ is the command-line version of mitmproxy, with the same
functionality but without the frills. Think tcpdump for HTTP.
-Both tools are fully documentented in the commandline __--help__ flag, and, in
-the case of __mitmproxy__, a built-in help page accessible through the __?__
+Both tools are fully documentented in the commandline _--help_ flag, and, in
+the case of __mitmproxy__, a built-in help page accessible through the _?_
keyboard shortcut.
@@ -37,7 +38,7 @@ Requirements
------------
* [Python](http://www.python.org) 2.6.x or 2.7.x.
-* [openssl](http://www.openssl.org/). Installed by default on most systems.
+* [openssl](http://www.openssl.org/) - installed by default on most systems.
* [urwid](http://excess.org/urwid/) version 0.9.8 or newer.
* The test suite uses the [pry](http://github.com/cortesi/pry) unit testing
library.