$Id: README,v 1.17 2001/04/20 15:56:38 michael Exp $

XML-RPC for Ruby
Copyright (C) 2001 by Michael Neumann (neumann@s-direktnet.de)
License is the same as Ruby's

For more information about XML-RPC look at http://www.xmlrpc.com.

ACKNOWLEDGMENTS
===============
I have included John W. Small's (jsmall@laser.net) ruby-generic-server 
into this package, so that you'll not need to download it.
For copyright notice and license, see file "lib/GServer.rb".
It is available from RAA. Thanks for his implementation.
For the documentation, I use the style-sheet of RWiki from NaHi.

PREREQUISITES
=============
You need either NQXML (I use version 0.6.1) or XMLParser (I use version 0.6.1) from RAA, 
and a Ruby version >= 1.6. 
(No, it's not a typo. Both NQXML and XMLParser have the same version.)

TEST
=====
If you want, you can execute the testcases, to make sure, 
all (for which testcases exist) works correctly.
Therefore you need "RUNIT" from RAA installed.
Then go into directory "test" (you have to go into 
this directory, otherwise it will not work!!!), 
and run "ruby test.rb". If in the last line there's an
"OK", all works as expected.

INSTALL
=======
Type "ruby install.rb" in current directory.
Make sure you have root priviledges before you do this.

The XML-RPC library files are installed in your site_ruby directory,
of the actual ruby-version (e.g. "site_ruby/1.6") under the 
directory "xmlrpc".


DOCUMENTATION
=============
Open doc/index.html in a web-browser.


SAMPLES
=======
See samples/validator/validator1.rb for a very good example.
I've also included one example of an XML-RPC cgi-based server and
a ruby-program which calles it.
"samples/xml.cgi" is the cgi-based server, which should be placed
into your cgi-bin directory of your web-server.
"sampels/call.rb" is the client-side which calls the server (check 
the URL /cgi-bin/xml.cgi in samples/call.rb if it points to the cgi-based
server-script)

PROBLEMS
========
A problem is that XML-RPC do not specify the timezone. 
I use Time.gm(...) to create a Time object!


TODO
====
See file ToDo.

