Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added some additional information to the readme

[ci skip]
  • Loading branch information...
commit 28209ecaf6272540a8b058dca6e6def813fca11a 1 parent fa87f15
Daniel Harrington rubiii authored
Showing with 22 additions and 10 deletions.
  1. +22 −10 README.md
32 README.md
View
@@ -1,16 +1,16 @@
-Savon
-=======
+# Savon
Heavy metal SOAP client
[Documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) |
[Mailing list](https://groups.google.com/forum/#!forum/savonrb) | [Twitter](http://twitter.com/savonrb)
-[![Build Status](https://secure.travis-ci.org/savonrb/savon.png)](http://travis-ci.org/savonrb/savon) [![Gem Version](https://badge.fury.io/rb/savon.png)](http://badge.fury.io/rb/savon)
+[![Build Status](https://secure.travis-ci.org/savonrb/savon.png)](http://travis-ci.org/savonrb/savon)
+[![Gem Version](https://badge.fury.io/rb/savon.png)](http://badge.fury.io/rb/savon)
+[![Code Climate](https://codeclimate.com/github/savonrb/savon.png)](https://codeclimate.com/github/savonrb/savon)
-Installation
-------------
+## Installation
Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
@@ -18,9 +18,14 @@ Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be
$ gem install savon
```
+or add it to your Gemfile like this:
-Introduction
-------------
+```
+gem 'savon', '~> 2.1.0'
+```
+
+
+## Usage example
``` ruby
require 'savon'
@@ -38,8 +43,15 @@ response.body
# => { find_user_response: { id: 42, name: 'Hoff' } }
```
+For more examples, you should check out the [integration tests](https://github.com/savonrb/savon/tree/master/spec/integration).
+
+
+## Documentation
+
+Please make sure to read the documentation for your version:
-Documentation
--------------
+* [Version 2](http://savonrb.com/version2.html)
+* [Version 1](http://savonrb.com)
-Continue reading at [savonrb.com](http://savonrb.com)
+And if you find any problems with it or if you think something's missing,
+feel free to [help out and improve the documentation](https://github.com/savonrb/savonrb.com).
Please sign in to comment.
Something went wrong with that request. Please try again.