Added simple README file, derived from POD comments in SimpleServer.pm

Fixed my (Mike Taylor's) email address

diff --git a/Changes b/Changes
index 218669e..2ba8f55 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,10 +1,14 @@
 Revision history for Perl extension Net::Z3950::Server.
 
-0.05  Tue Feb 05 21:54:30
+0.06  (in progress)
+       - We actually removed the vacuous Changelog and TODO files
+         back in 0.05.  They should never have been here :-)
+
+0.05  Tue Feb 05 21:54:30 2002
         - Add brief documentation of the new handling
          of RPN.
 
-0.04  Tue Feb 05 21:49:56 
+0.04  Tue Feb 05 21:49:56 2002
        - Add Changelog (### Why?  We already have this file!)
        - Add TODO file (although it's empty!)
        - Change interface to constructor, and fix test.pl script to
@@ -18,7 +22,7 @@ Revision history for Perl extension Net::Z3950::Server.
          for some reason.)
        - Fix typos in documentation.
 
-0.03  Thu Nov 09 16:22:00
+0.03  Thu Nov 09 16:22:00 2000
        - Add the INSTALL file.
        - Add support for a present-handler (distinct from fetch).
        - Remove `$args->{LEN} = length($record)' from the example

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..4b03269
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+Net::Z3950::SimpleServer - Simple Perl API for building Z39.50 servers.
+
+The SimpleServer module is a tool for constructing Z39.50 "Information
+Retrieval" servers in Perl. The module is easy to use, but it does
+help to have an understanding of the Z39.50 query structure and the
+construction of structured retrieval records.
+
+Z39.50 is a network protocol for searching remote databases and
+retrieving the results in the form of structured "records". It is
+widely used in libraries around the world, as well as in the US
+Federal Government. In addition, it is generally useful whenever you
+wish to integrate a number of different database systems around a
+shared, asbtract data model.
+
+The model of the module is simple: It implements a "generic" Z39.50
+server, which invokes callback functions supplied by you to search for
+content in your database. You can use any tools available in Perl to
+supply the content, including modules like DBI and WWW::Search.
+
+The server will take care of managing the network connections for you,
+and it will spawn a new process (or thread, in some environments)
+whenever a new connection is received.
+
+AUTHORS
+       Anders Sønderberg (sondberg@indexdata.dk) and Sebastian Hammer
+       (quinn@indexdata.dk).  Substantial contributions made by Mike
+       Taylor (mike@miketaylor.org.uk).

diff --git a/SimpleServer.pm b/SimpleServer.pm
index c4b5c96..d6546e7 100644 (file)
--- a/SimpleServer.pm
+++ b/SimpleServer.pm
@@ -26,7 +26,11 @@
 ##
 
 ## $Log: SimpleServer.pm,v $
-## Revision 1.12  2002-03-05 20:52:22  sondberg
+## Revision 1.13  2002-03-06 11:02:04  mike
+## Added simple README file, derived from POD comments in SimpleServer.pm
+## Fixed my (Mike Taylor's) email address
+##
+## Revision 1.12  2002/03/05 20:52:22  sondberg
 ## Version 0.05 so that we can release the thing at CPAN.
 ##
 ## Revision 1.11  2002/03/05 20:49:56  sondberg
@@ -508,15 +512,12 @@ or something similar, this is the place to do it.
 =head1 AUTHORS
 
 Anders Sønderberg (sondberg@indexdata.dk) and Sebastian Hammer
-(quinn@indexdata.dk). Substantial contributions made by Mike Taylor (mike@tecc.co.uk).
+(quinn@indexdata.dk). Substantial contributions made by Mike Taylor
+(mike@miketaylor.org.uk).
 
 =head1 SEE ALSO
 
-perl(1).
-
 Any Perl module which is useful for accessing the database of your
 choice.
 
 =cut
-
-