include/securimage/README.txt

   1 NAME:
   2
   3     Securimage - A PHP class for creating and managing form CAPTCHA images
   4
   5 VERSION: 1.0.2
   6
   7 AUTHOR:
   8
   9     Drew Phillips <drew@drew-phillips.com>
  10
  11 DOWNLOAD:
  12
  13     The latest version can always be
  14     found at http://www.phpcaptcha.org
  15
  16 DOCUMENTATION:
  17
  18     Online documentation of the class, methods, and variables can
  19     be found at http://www.phpcaptcha.org/Securimage_Docs/
  20
  21 REQUIREMENTS:
  22     PHP 4.3.0
  23     GD  2.0
  24     FreeType (optional, required for TTF support)
  25
  26 SYNOPSIS:
  27
  28     require_once 'securimage.php';
  29
  30     $image = new Securimage();
  31
  32     $image->show();
  33
  34     // Code Validation
  35
  36     $image = new Securimage();
  37     if ($image->check($_POST['code']) == true) {
  38       echo "Correct!";
  39     } else {
  40       echo "Sorry, wrong code.";
  41     }
  42
  43 DESCRIPTION:
  44
  45     What is Securimage?
  46
  47     Securimage is a PHP class that is used to generate and validate CAPTCHA images.
  48     The classes uses an existing PHP session or creates its own if none is found to store the
  49     CAPTCHA code.  Variables within the class are used to control the style and display of the image.
  50     The class supports TTF fonts and effects for strengthening the security of the image.
  51     If TTF support is not available, GD fonts can be used as well, but certain options such as
  52     transparent text and angled letters cannot be used.
  53
  54
  55 COPYRIGHT:
  56     Copyright (c) 2007 Drew Phillips. All rights reserved.
  57     This software is released under the GNU Lesser General Public License.