Vice Stats
==========

Vice Stats is an advanced web site statistics gathering package.  It
collects data about the resources in a web site, the visitors to that
site, and the referring resources.  It runs in PHP and stores its
data in a MySQL database.

Current version: 0.2 beta
Release date:    May 7th, 2005
Homepage:        http://www.arantius.com/topic/arantius/vice+stats/

Features
========

Vice Stats provides the following features:

 - Reporting of recent and frequent search phrases.
 - Reporting of recent and frequent referring URLs.
 - Reporting of recently and frequently accessed resources.
 - Hourly (past 24 hours) and daily (past 7 days) reporting
   of total hits and unique visitors.
 - Demographic breakdown by: country, browser, platform.
 - Graphical reporting on: frequent searches, frequent
   referrers, frequently accessed resources, hourly and
   daily hits & visits, countries, browsers, and platforms.
 - Visitor session tracking.
 - Real time reporting.
 - Ignore a visitor based off IP address or special cookie.

Vice Stats, in it's default configuration, is completely invisible to
the end user.  No extra scripts are sent to the browser, no cookies, and
no images.  Therefore, tracking cannot be blocked, intentionally or
inadvertently.  Separate modes employing javascript and cookies are
also available if desired.  Each mode has it's strengths and weaknesses,
so you may choose which to use.

Vice Stats is designed to be primarily a "real time" reporting tool, 
providing insight into the recent happenings on your website.

Documentation
=============

The following documentation files are available in this distribution:

COPYING       Copyright and license information
CREDITS       Details on the individuals and groups who have contributed
INSTALL       Instructions for installation
README        This file
RELEASE_NOTES Information about each different version
TODO          Notes about incomplete or upcoming features

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

Please read the file INSTALL for instructions how to install or upgrade
this package.

License
=======

Vice Stats - Web site statistics gathering suite.
Copyright (C) 2005 Anthony Lieuallen

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA