================================================================================
ruby-pg: Ruby interface to PostgreSQL RDBMS
================================================================================

This library is copyrighted by the authors.

Authors:
  * Yukihiro Matsumoto <matz@ruby-lang.org>
      Author of Ruby.
  * Eiji Matsumoto <usagi@ruby.club.or.jp>
      One of users who loves Ruby.
  * Jeff Davis <ruby-pg@j-davis.com>

Thanks to:
  * Noboru Saitou <noborus@netlab.jp>
      Past maintainer.
  * Dave Lee
      Past maintainer.
  * Guy Decoux   ts <decoux@moulon.inra.fr> 
  
Maintainer:
  Jeff Davis <ruby-pg@j-davis.com>

Copying:
  You may redistribute this software under the terms of the GPL,
  included in the file named GPL; or under the same terms as Ruby,
  included in the file name LICENSE.

- Summary

This is the extension library to access a PostgreSQL database from Ruby.
This library works with PostgreSQL 7.4 and later.

- Requirements

  Ruby 1.8 or later.
  PostgreSQL 7.4 or later installed.

  It may work with earlier versions as well, but those are
  not regularly tested.

- How to install ?

Follow the instructions below to compile and install:

  ruby extconf.rb
  make
  su              (if necessary)
  make install

You may need to specify the directory name for the include files and the
-lpq library by using

    --with-pgsql-include=<include file directory>
    --with-pgsql-lib=<library directory>

For example:

  ruby extconf.rb --with-pgsql-include=/usr/local/pgsql/include \
                  --with-pgsql-lib=/usr/local/pgsql/lib

- How to use ?

You need to specify:

  require 'pg' or
  require 'postgres'

These are two different modules, with important differences.

The 'postgres' module is the older module, maintained for backwards
compatibility. It has known flaws that aren't reasonably fixable without
breaking backwards compatibility. Use this module if you have code that
already works, and you just want the fixes that I've committed to this
module (for instance, this module is compatible with PostgreSQL 8.3).

The 'pg' module is the newer module, that has been greatly improved, and
is almost a complete rewrite. It is not backwards compatible. Use this module
for newly written code. It should be more stable, less buggy, and has more
features.

See the RDoc documentation for detailed usage instructions.

- Acknowledgments

We are thankful to the people at the ruby-list and ruby-dev mailing lists.
And to the people who developed PostgreSQL.

- Copying

This library is copyrighted by its authors; Yukihiro Matsumoto, and Eiji
Matsumoto.

Portions copyright Laika, Inc.



