$Id: README,v 1.3 2002/06/19 06:26:19 ianmacd Exp $


WHAT IS IT?
-----------

Ruby/Password comprises a set of useful methods for creating, verifying and
manipulating passwords. It includes an interface to CrackLib, a library
commonly used for checking password strength.

From the CrackLib README:

  CrackLib makes literally hundreds of tests to determine whether you've
  chosen a bad password.

  * It tries to generate words from your username and gecos entry to tries
  to match them against what you've chosen.

  * It checks for simplistic patterns.

  * It then tries to reverse-engineer your password into a dictionary
  word, and searches for it in your dictionary.

  - after all that, it's PROBABLY a safe(-ish) password.  8-)


The target audience for this library is system administrators who need
to write Ruby programs that prompt for, generate, verify and encrypt
passwords.


INSTALLATION
------------

Please see the INSTALL file for details of how to install Ruby/Password.


USAGE
-----

Please see the man page or HTML documentation for details of how to use
Ruby/Password.


LICENCE
-------

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, or (at your option)
any later version.

Please see the file COPYING for the terms of the licence.