===============================================================================
btpd-webui - BitTorrent Protocol Daemon Web UI
===============================================================================

btpd-webui is a simple web frontend to the btpd program.  

Authors:
    Scott Walker - iswalker at gmail dot com
    
Contributers:
    Putru Paler  - bencode.py module
    Tomas Styblo - htmltmpl.py module
    
Homepage:
    http://code.google.com/p/btpd-webui/


===============================================================================
Installation
===============================================================================

Requirements:

- Python 2.4 or higher.

- Twisted 2.5 or higher (specifically twisted-web)     
  In Ubuntu Linux, install the following packages:
    - python-twisted-bin 
    - python-twisted-core
    - python-twisted-web      
  NOTE: btpd-webui is written using the twitsted-web framework,
        _not_ the twisted-web2 framework.            

- Btpd 0.13


Installation:
    
Simply run 'python setup.py install'.
Run 'python setup.py --help' for more options.


===============================================================================
Usage
===============================================================================

btpd-webui is usually controlled via the 'btpd-webui' command.  
This will run btpd-webui as a daemon using the twistd program.
If you want to run btpd-webui directly, you can use 'btpd-webui-server'.

The first time the program runs, it creates the ~/.btpd-webui directory.  This
directory contains the configuration file and default content directory.  
It also contains the twistd.pid and twistd.log files when btpd-webui is using
twistd to run in daemon mode.


===============================================================================
Configuration
===============================================================================

Configuration is done through the ~/.btpd-webui/config file.  A default
configuration file is created the first time btpd-webui is launched. 
Changes do not take effect until btpd-webui is restarted.

