README.txt

************* Note that this is a clone of repository at https://code.google.com/p/proxy-vole/ **********
Cloned here so that we have the source when google code is retired and also can support pushing the binaries to maven central.
*********************************************************************************************************

Introduction:
-------------
The intent of this project is to build a framework to detecting the proxy settings
used by the current platform. There are multiple strategies available to detect the 
proxy settings. Proxy Vole will detect proxy settings from: 
KDE, Gnome, Windows, Firefox, Internet Explorer, ...

See java doc for usage examples and API details. 

There is also a change log in the doc folder.

Building
--------
The source can be found on the homepage at: http://code.google.com/p/proxy-vole/ 
An Eclipse project to build the source is included. 
For windows some native code is used to read the IE proxy configuration.
For the windows dll an Visual Studio project is included.
There is also an maven build file to create an JAR file for deployment.
To build and use the library you will need Java 1.5 or higher.
For some features you will need Java 1.6

License:
--------
This project is released under BSD license (see LICENSE.txt for details).

Have fun

	- Bernd Rosstauscher