README.rdoc in RightScaleAPIHelper-0.4.0 vs README.rdoc in RightScaleAPIHelper-0.4.1
- old
+ new
@@ -1,7 +1,19 @@
= RightScaleAPIHelper
-Description goes here.
+This GEM is a simple wrapper for the RightScale API. It simplifies authentication, and provides an object to run GET, PUT, POST, and DELETE calls.
+
+== Usage
+ Create new instance
+ RightScaleAPIHelper::Helper.new(acct_id, email, password, format=('js'/'xml'), version = 1.0)
+
+Example
+ api_conn = RightScaleAPIHelper::Helper.new(123456, 'email@email.com', 'password')
+
+ resp = api_conn.get("/deployments")
+ puts resp.code # Response code from RightScale
+ puts resp.body # xml or json response
+
== Contributing to RightScaleAPIHelper
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.