Replace boilerplate with accurate information.
authorMike Taylor <mike@indexdata.com>
Fri, 17 Dec 2004 17:16:46 +0000 (17:16 +0000)
committerMike Taylor <mike@indexdata.com>
Fri, 17 Dec 2004 17:16:46 +0000 (17:16 +0000)
README

diff --git a/README b/README
index f2e7c87..ce938c3 100644 (file)
--- a/README
+++ b/README
@@ -1,38 +1,43 @@
-Net/Z3950/PQF version 0.01
-==========================
+$Id: README,v 1.2 2004-12-17 17:16:46 mike Exp $
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
 
-A README file is required for CPAN modules since CPAN extracts the
-README file from a module distribution so that people browsing the
-archive can use it get an idea of the modules uses. It is usually a
-good idea to provide version information here so that people can
-decide whether fixes for the module are worth downloading.
+Net::Z3950::PQF
+===============
 
-INSTALLATION
+This library provides a parser for PQF (Prefix Query Format), an ugly
+but precise string format for expressing Z39.50 Type-1 queries. This
+format is widely used behind the scenes of Z39.50 applications, and is
+also used extensively with test-harness programs such as the YAZ
+command-line client, yaz-client.
+
+
+Installation
+------------
 
 To install this module type the following:
 
-   perl Makefile.PL
-   make
-   make test
-   make install
+       perl Makefile.PL
+       make
+       make test
+       make install
+
 
-DEPENDENCIES
+Dependencies
+------------
 
 This module requires these other modules and libraries:
 
-  blah blah blah
+       [None!]
 
-COPYRIGHT AND LICENCE
 
-Put the correct copyright and licence information here.
+Copyright and Licence
+---------------------
 
-Copyright (C) 2004 Mike Taylor
+Written by Mike Taylor <mike@indexdata.com>
+
+Copyright (C) 2004 by Index Data ApS.
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself. 
 
+