Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hsbt committed Mar 15, 2016
1 parent c480800 commit 2d30de8
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Xmlrpc
# XMLRPC

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.
## Overview

TODO: Delete this and the text above, and describe your gem
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.

## Installation

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

$ gem install xmlrpc

## Usage
## Example

TODO: Write usage instructions here
Try the following code. It calls a standard demonstration remote procedure.

```ruby
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
```

## Development

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

## Contributing

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


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Released under the same term of license as Ruby.

0 comments on commit 2d30de8

Please sign in to comment.