File: readme.txt
Script Name: vList Lite 1.1
Author: Vincent Ryan Ong
Email: support@beanbug.net

Description:
vList Lite is a simple mailing list management system. The script lets
visitors of your site join your mailing list. As list administrator,
you have the option to send Text or HTML messages to everyone in the list.
Just like the vScripts tradition, this script includes a flexible design, 
subscribers, and message sending administration. Members can also unsubscribe 
through an unsubscribe form.

This script is a freeware but if you want to give donations,
please send your checks (coz cash will probably be stolen in the
post office) them to:

Vincent Ryan Ong
Rm. 440 Wellington Bldg.
655 Condesa St. Binondo, Manila
Philippines, 1006


==============================
 vList Lite 1.0 README FILE
==============================

Contents:
  * Introduction
  * Package content
  * Requirements
  * Installation
  * Administration
  * Usage
  * Change Log

~~~~~~~~~~~~~~~~~~~~~~~

* INTRODUCTION

  vList Lite is amailing list management system which can integrate with any
  existing website that meets the requirements. 


    FEATURES:
    1. Flexibility
	= vList Lite allows administrators and webmasters to integrate it
	  with the current website. This is specially useful if major changes 
	  are going to be painful.
    
    2. Speed
	= vList Lite uses the dynamic-duo of PHP and MySQL which enables
	  blazing fast transactions where only your server speed dictates 
	  the limit.
    
    3. Compactness
	= vList Lite is very small thus takes up little space allowing 
	  you more room to enhance your site's other features.

    4. Text/HTML Email
	= vList Lite allows you to choose between sending text or HTML messages.
	  As we all know, HTML messages are easier and more interesting to read 
	  compared to text-based messages. However, not all email clients allow
	  HTML messages. 

    5. Hidden list members
	= vList Lite hides the member-list of your mailing list so that they
	  cannot spam or get other people's email address and use it for sending
	  spam mail.


* PACKAGE CONTENT

  createdb.sql - database creation file
  listconfig.php - file and database configuration file 
  readme.txt - this file
  list.php - mailing list form. this must be "included" in other pages.
  listadmin.php - admin function home
  listdesign.php - design administration
  listsend.php - mail editor
  listsubscribers.php - subscriber management administrative interface
  listunsubscribe.php - unsubscribe form


* REQUIREMENTS

  OS: Linux, Windows NT/2000/Whistler(XP) Server Family, Unix
  WEB SERVER: Apache (latest release) [PWS and IIS not recommended]
  SCRIPTING: PHP 4 (latest stable release)
  DB: MySQL (latest stable release)
  DB MANAGEMENT: phpMyAdmin or any similar types of db manager 
  Permission to use mail() function of PHP.

* INSTALLATION

  1. Edit listconfig.inc and set the values to reflect your host's
     	configuration for the DB and your desired configuration for
	the email settings. 

  2. Edit list.php's first line (include statement) such that it will be:
	<?php include("[dir path]/listconfig.php"); ?>
	where [dir path] is the path to listconfig.inc from the folder
	where vList Lite is to be embedded. For more details, please
	see section regarding USAGE below.

  3. Execute createdb.sql in phpMyAdmin or any other DB Management
	software to create the tables.

  4. Upload every file (you may not do this with createdb.sql if you
	want) in ASCII mode to your web directory. It is recommended
	that you store it in its own directory. Preferrable called
	"vListLite".


* ADMINISTRATION

  After installation, 2 new table named "listdesign" and "listsubscribers"
  should have been created including the built-in users and groups.
  Follow the instructions below to administer vAuthenticate.

    DESIGN ADMINISTRATION:
    1. Point your browser to the listadmin.php (List admin home)
    2. Click on Design Administration
    3. Change values for fields.
    4. Save Changes

    SUBSCRIBER MAINTENANCE:
    1. Point your browser to the listadmin.php (List admin home) OR
    2. Click on Subscriber Maintenance
    3. To add a new subscriber, enter the email address in the input field and 
	press Add Subscriber.
    4. To remove a subscriber, select the email from the list and press the 
	Remove Subscriber button. You can select multiple email addresses from
	the list by holding down the Ctrl key and clicking on the desired email
	address.
    5. To clear the mailing list, press the Clear List button.

    SENDING MAIL TO LIST:
    1. Point your browser to the listadmin.php (List admin home) OR
    2. Click on Send to List
    3. Enter a subject for your mail
    4. Enter the message in the multiline text box. Paste or compose your HTML 
	mail in this box.
    5. Choose your message type
    6. Press "Send Now!" button

* USAGE
    
    The most common usage for vList Lite is by "including" it in an existing webpage.
	In the existing page, insert a code like this:
	<?php include("[dir path]/list.php"); ?>
	where <dir path> is the directory path where list.php can be found.

    After that, don't forget to EDIT list.php such that the first line after my comments
	(an include statement) should be something like:
	<?php include("[dir path]/listconfig.php"); ?>
	where <dir path> is the directory path where listconfig.php can be found.

    Example:
	You want going to embed vList Lite in your index.php (it should be a php, php3,
	or php4 file because *.html won't process php statements) file which is located in 
	the root directory of your site. You have stored the vList Lite files in the 
	directory named "vListLite" which can be found also in the root directory of
	your site. All you have to do is edit your index.php file and insert the
	following code in the area where you want vList Lite to show:
	
	<?php include("vListLite/list.php"); ?>

	The list.php file should also be edited (first line only after my comments)
	to reflect the proper include path. This will result in:

	<?php include("vListLite/listconfig.php"); ?>

	Since listconfig.inc is in the same directory as list.php, why then should we
	reference it the same was as we have referenced list.php? This is because we 
	called list.php from the root folder. Because of this, list.php also calls 
	listconfig.php from the root folder. Thus, it should be referenced in the same way.


* CHANGE LOG
	Version 1.1 - Changed the configuration file extension to .php to put a 
			cork in the security hole.


**************************************
THAT's IT!
SUPPORT: support@beanbug.net
**************************************
