README.md in hugs-1.1.0 vs README.md in hugs-1.2.0
- old
+ new
@@ -1,22 +1,24 @@
# Hugs
Hugs net-http-persistent with convenient get, delete, post, and put methods.
-Opted to write this gem for two reasons:
+Opted to write this gem for four reasons:
* [Ganeti's API](http://docs.ganeti.org/ganeti/2.2/html/rapi.html), required
the sending of a message body with the HTTP Get request, which
[rest-client](https://github.com/archiloque/rest-client) does not do.
* Wanted a [fast](http://blog.segment7.net/articles/2010/05/07/net-http-is-not-slow),
thread-safe, and persistent client.
+* [Excon](https://github.com/geemus/excon) does most everything right, but is not
+ compatible with [VCR](https://github.com/myronmarston/vcr).
+* Wanted to learn how to handle this pattern.
## Assumptions
-* The webservice returns JSON.
+* The webservice returns JSON or XML.
* You want to objectify the returned JSON.
-* The message body is JSON.
## Usage
### Bundler
@@ -26,8 +28,7 @@
See the 'Examples' section in the [wiki](http://github.com/retr0h/rubineti/wiki/).
### TODO
-* Remove HTTP Auth requirement, as mentioned in the 'Assumptions' section.
* Move @request instance method in #response_for to local. It was set to an instance
for ease of testing but it bothers me.