README.txt and README.mkd tweaks.
This commit is contained in:
parent
f5ca88fe0a
commit
680801a47e
|
@ -5,6 +5,9 @@ clients and servers. The project has three components:
|
|||
- __pathoc__, a perverse HTTP client.
|
||||
- __libpathod.test__, an API for easily using __pathod__ and __pathoc__ in unit tests.
|
||||
|
||||
|
||||
# Documentation
|
||||
|
||||
The pathod documentation is self-hosted. Just fire up pathod, like so:
|
||||
|
||||
./pathod
|
||||
|
@ -13,6 +16,10 @@ 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
|
||||
|
||||
|
|
41
README.txt
41
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:
|
||||
|
||||
FIXME
|
||||
* netlib_
|
||||
* requests_
|
||||
|
||||
The project's test suite uses the nose_ unit testing framework.
|
||||
|
||||
.. _netlib: http://github.com/cortesi/netlib
|
||||
.. _requests: http://docs.python-requests.org/en/latest/index.html
|
||||
.. _nose: http://nose.readthedocs.org/en/latest/
|
||||
|
|
Loading…
Reference in New Issue