aboutsummaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2012-07-29 15:49:26 +1200
committerAldo Cortesi <aldo@nullcube.com>2012-07-29 15:49:26 +1200
commit680801a47edd9cf26f1f1b798ed545d9eb875ff9 (patch)
treeecc9e7b2513b1dfbca4bf8c186e64b93f4c925ad /README.txt
parentf5ca88fe0af47a8cb7cff20ce2d117e3fc716e4d (diff)
downloadmitmproxy-680801a47edd9cf26f1f1b798ed545d9eb875ff9.tar.gz
mitmproxy-680801a47edd9cf26f1f1b798ed545d9eb875ff9.tar.bz2
mitmproxy-680801a47edd9cf26f1f1b798ed545d9eb875ff9.zip
README.txt and README.mkd tweaks.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt41
1 files changed, 33 insertions, 8 deletions
diff --git a/README.txt b/README.txt
index 6feb5c3c..c531b93a 100644
--- a/README.txt
+++ b/README.txt
@@ -1,18 +1,43 @@
-__pathod__ is a collection of pathological tools for testing and torturing HTTP
+**pathod** is a collection of pathological tools for testing and torturing HTTP
clients and servers. The project has three components:
-- __pathod__, an pathological HTTP daemon.
-- __pathoc__, a perverse HTTP client.
-- __libpathod.test__, an API for easily using __pathod__ and __pathoc__ in unit tests.
+- **pathod**, an pathological HTTP daemon.
+- **pathoc**, a perverse HTTP client.
+- **libpathod.test**, an API for easily using pathod and pathoc in unit tests.
-# Installing
+Documentation
+-------------
-If you already have __pip__ on your system, installing __pathod__ and its
+The pathod documentation is self-hosted. Just fire up pathod, like so:
+
+ ./pathod
+
+And then browse to:
+
+ http://localhost:9999
+
+You can aways view the documentation for the latest release at the pathod
+website:
+
+ http://pathod.net
+
+
+Installing
+----------
+
+If you already have **pip** on your system, installing **pathod** and its
dependencies is dead simple:
pip install pathod
-The project uses the __nose__ unit testing framework, which you can get here:
+The project has the following dependencies:
+
+* netlib_
+* requests_
+
+The project's test suite uses the nose_ unit testing framework.
- FIXME
+.. _netlib: http://github.com/cortesi/netlib
+.. _requests: http://docs.python-requests.org/en/latest/index.html
+.. _nose: http://nose.readthedocs.org/en/latest/