---------------------------------------------------------------------------

This file is for maintainers of a software distribution which would like
to include libwhisker.  I thought I'd document a few things in order to
make your life easier.

---------------------------------------------------------------------------

First, here's a brief recommended description of libwhisker for use.  If
it's too long, then just use the first two sentences.

Libwhisker is a Perl library useful for HTTP testing scripts.  It
contains a pure-Perl reimplementation of functionality found in the LWP,
URI, Digest::MD5, Digest::MD4, Data::Dumper, Authen::NTLM, HTML::Parser,
HTML::FormParser, CGI::Upload, MIME::Base64, and GetOpt::Std modules.
Libwhisker is designed to be portable (a single perl file), fast (general
benchmarks show libwhisker is faster than LWP), and flexible (great care
was taken to ensure the library does exactly what you want to do, even
if it means breaking the protocol).

---------------------------------------------------------------------------

You need to make sure the LW2.pm is installed in the system perl module
directory. I very, very, *very* STRONGLY suggest that you depreciate any
libwhisker 1.x packages and instead install the LW.pm included in the
libwhisker 2.x compat/ directory.  The compatible-LW.pm provides the
normal libwhisker 1.x functionality using the libwhisker 2.x library.  
This allows both libwhisker 1.x and 2.x support to be contained in a single
libwhisker package (preferred).

Documentation for LW2 is embedded inside the final LW2.pm (unless you build
with the 'nopod' option).  You should use pod2man and store the resulting
output amongst the local collection of Perl module manpages.  Use of the
Makefile.pl 'install' option does this automatically.

The files in docs/ and scripts/ are for programming references, and as
such, should not be installed with a normal package.  If you truly do want
to include supporting files, then I recommend only the following:

	docs/crawler.txt
	docs/whisker_hash.txt
	docs/logo-builton.gif
	docs/logo-name.gif
	docs/logo-plain.gif
	scripts/api_demo.pl
	scripts/crawl_demo.pl
	scripts/simple_demo.pl

---------------------------------------------------------------------------