aboutsummaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt30
1 files changed, 12 insertions, 18 deletions
diff --git a/README.txt b/README.txt
index c1c544de..6feb5c3c 100644
--- a/README.txt
+++ b/README.txt
@@ -1,24 +1,18 @@
+__pathod__ is a collection of pathological tools for testing and torturing HTTP
+clients and servers. The project has three components:
-**pathod** is a pathological HTTP/S daemon, useful for testing and torturing
-HTTP clients. At **pathod**'s heart is a tiny, terse language for crafting HTTP
-responses. The simplest way to use **pathod** is to fire up the daemon, and
-specify the response behaviour you want using this language in the request URL.
-Here's a minimal example:
+- __pathod__, an pathological HTTP daemon.
+- __pathoc__, a perverse HTTP client.
+- __libpathod.test__, an API for easily using __pathod__ and __pathoc__ in unit tests.
- http://localhost:9999/p/200
-Everything after the "/p/" path component is a response specifier - in this
-case just a vanilla 200 OK response. See the complete docs to get (much)
-fancier. You can also add anchors to the **pathod** server that serve a fixed
-response whenever a matching URL is requested:
+# Installing
- pathod --anchor "/foo=200"
+If you already have __pip__ on your system, installing __pathod__ and its
+dependencies is dead simple:
+
+ pip install pathod
-Here, "/foo" a regex specifying the anchor path, and the part after the "=" is
-a response specifier.
+The project uses the __nose__ unit testing framework, which you can get here:
-**pathod** also has a nifty built-in web interface, which lets you play with
-the language by previewing responses, exposes activity logs, online help and
-various other goodies. Try it by visiting the server root:
-
- http://localhost:9999
+ FIXME