* lib/xmlrpc/README.txt: introduced for documentation purposes

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6243 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 31 insertions, 0 deletions

diff --git a/lib/xmlrpc/README.txt b/lib/xmlrpc/README.txt
new file mode 100644
index 0000000000..ade842d8b1
--- /dev/null
+++ b/lib/xmlrpc/README.txt
@@ -0,0 +1,31 @@
+= XMLRPC for Ruby, Standard Library Documentation
+
+== Overview
+
+XMLRPC is a lightweight protocol that enables remote procedure calls over
+HTTP.  It is defined at http://www.xmlrpc.com.
+
+XMLRPC allows you to create simple distributed computing solutions that span
+computer languages.  Its distinctive feature is its simplicity compared to
+other approaches like SOAP and CORBA.
+
+The Ruby standard library package 'xmlrpc' enables you to create a server that
+implements remote procedures and a client that calls them.  Very little code
+is required to achieve either of these.
+
+== Example
+
+Try the following code.  It calls a standard demonstration remote procedure.
+
+  require 'xmlrpc/client'
+  require 'pp'
+
+  server = XMLRPC::Client.new2("http://xmlrpc-c.sourceforge.net/api/sample.php")
+  result = server.call("sample.sumAndDifference", 5, 3)
+  pp result
+
+== Documentation
+
+See http://www.ntecs.de/projects/xmlrpc4r.  There is plenty of detail there to
+use the client and implement a server.
+