Skip to content

Commit 2d30de8

Browse files
committed
Update README
1 parent c480800 commit 2d30de8

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Xmlrpc
1+
# XMLRPC
22

3-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xmlrpc`. To experiment with that code, run `bin/console` for an interactive prompt.
3+
## Overview
44

5-
TODO: Delete this and the text above, and describe your gem
5+
XMLRPC is a lightweight protocol that enables remote procedure calls over
6+
HTTP. It is defined at http://www.xmlrpc.com.
7+
8+
XMLRPC allows you to create simple distributed computing solutions that span
9+
computer languages. Its distinctive feature is its simplicity compared to
10+
other approaches like SOAP and CORBA.
11+
12+
The Ruby standard library package 'xmlrpc' enables you to create a server that
13+
implements remote procedures and a client that calls them. Very little code
14+
is required to achieve either of these.
615

716
## Installation
817

@@ -20,9 +29,18 @@ Or install it yourself as:
2029

2130
$ gem install xmlrpc
2231

23-
## Usage
32+
## Example
2433

25-
TODO: Write usage instructions here
34+
Try the following code. It calls a standard demonstration remote procedure.
35+
36+
```ruby
37+
require 'xmlrpc/client'
38+
require 'pp'
39+
40+
server = XMLRPC::Client.new2("http://xmlrpc-c.sourceforge.net/api/sample.php")
41+
result = server.call("sample.sumAndDifference", 5, 3)
42+
pp result
43+
```
2644

2745
## Development
2846

@@ -32,10 +50,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
3250

3351
## Contributing
3452

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xmlrpc.
53+
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/xmlrpc.
3654

3755

3856
## License
3957

40-
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41-
58+
Released under the same term of license as Ruby.

0 commit comments

Comments
 (0)