From 8b02ebe2a4ff4a6f9c06c87afb22b7e007e92194 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sun, 29 Apr 2012 22:08:35 +1200 Subject: Docs, installation instructions. --- README.mkd | 9 +++++++++ README.txt | 24 ++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.mkd b/README.mkd index 5c321a6c..9ea50665 100644 --- a/README.mkd +++ b/README.mkd @@ -231,3 +231,12 @@ Supported data types are: whitespace ascii bytes + + +# Inastalling + +__pathod__ requires Tornado 2.2.1 or later. If you already have __pip__ on your +system, installing __pathod__ and its dependencies is dead simple: + + pip install pathod + diff --git a/README.txt b/README.txt index 2dbc2f93..cb369548 100644 --- a/README.txt +++ b/README.txt @@ -1,5 +1,25 @@ -Pathod is a pathological HTTP/S server, used for testing and stressing -unsuspecting client software. +**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: + 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: + + pathod --anchor "/foo=200" + +Here, "/foo" a regex specifying the anchor path, and the part after the "=" is +a response specifier. + +**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 -- cgit v1.2.3