aboutsummaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2011-03-19 19:47:19 +1300
committerAldo Cortesi <aldo@nullcube.com>2011-03-19 19:47:19 +1300
commit5015b1dfb2df3dee6444e0d5eea7525bdf0c735a (patch)
tree5439a2520c847aa2611822905cb2dcb9fc0d7f7a /README.mkd
parent93373efc8cbb95a40e6b4541a72be25e2bfbad4a (diff)
downloadmitmproxy-5015b1dfb2df3dee6444e0d5eea7525bdf0c735a.tar.gz
mitmproxy-5015b1dfb2df3dee6444e0d5eea7525bdf0c735a.tar.bz2
mitmproxy-5015b1dfb2df3dee6444e0d5eea7525bdf0c735a.zip
Docs - refinement and styling.
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd24
1 files changed, 13 insertions, 11 deletions
diff --git a/README.mkd b/README.mkd
index 5c6e3e2f..1b143066 100644
--- a/README.mkd
+++ b/README.mkd
@@ -10,7 +10,7 @@ keyboard shortcut.
Capabilities
-============
+------------
- Intercept HTTP requests and responses and modify them on the fly.
- Save complete HTTP conversations for later replay and analysis.
@@ -21,24 +21,26 @@ Capabilities
Download
-========
+--------
-Releases can be found here: http://corte.si/projects.html
+Releases and rendered documentation can be found on the mitmproxy website:
-Source is hosted here: http://github.com/cortesi/mitmproxy
+[mitmproxy.org](http://mitmproxy.org)
+
+Source is hosted on github:
+
+[github.com/cortesi/mitmproxy](http://github.com/cortesi/mitmproxy)
Requirements
-============
+------------
-* A recent [Python](http://www.python.org) interpreter.
-* SSL certificates are generated using [openssl](http://www.openssl.org/)
-* The curses interface relies on version 0.9.8 or newer of the
- [urwid](http://excess.org/urwid/) library.
+* A recent [Python](http://www.python.org) interpreter
+* [openssl](http://www.openssl.org/)
+* [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.
-* mitmproxy is tested and developed on OSX, Linux and OpenBSD. You may be able
- to get it running using Cygwin on Windows, but don't count on it.
+* mitmproxy is tested and developed on OSX, Linux and OpenBSD.
You should also make sure that your console environment is set up with the
following: