README.rdoc in restfully-0.2.2 vs README.rdoc in restfully-0.2.3

- old
+ new

@@ -7,11 +7,11 @@ == Installation $ gem install restfully == Usage === Command line - $ resfully api_base_uri relative_root_uri [-u username] [-p password] + $ resfully base_uri [root_path] [-u username] [-p password] e.g., for the Grid5000 API: $ restfully https://api.grid5000.fr/sid /grid5000 -u username -p password If the connection was successful, you should get a prompt. Call the +root+ function to see what are the available resources. <tt>@property</tt> means that you can call the +property+ method on the object. Other properties are available via the <tt>[]</tt> function. @@ -26,12 +26,14 @@ @sites: Restfully::Collection @version: Restfully::Resource @versions: Restfully::Collection ------------ PROPERTIES ------------ "version" => "ee1f8111c8835496a9e4a6f7c9491c0238ee9827"> + irb(main):006:0> root.uri => "/grid5000" + irb(main):007:0> root.sites => #<Restfully::Collection:0x8faaf2 ------------ META ------------ @uri: "/grid5000/sites" ------------ PROPERTIES ------------ @@ -44,10 +46,11 @@ "nancy" => Restfully::Resource "bordeaux" => Restfully::Resource "orsay" => Restfully::Resource> irb(main):008:0> root['version'] => "ee1f8111c8835496a9e4a6f7c9491c0238ee9827" + irb(main):009:0> root.version => #<Restfully::Resource:0x8facf0 ------------ META ------------ @uri: "/grid5000/versions/ee1f8111c8835496a9e4a6f7c9491c0238ee9827" @uid: "ee1f8111c8835496a9e4a6f7c9491c0238ee9827" @@ -59,10 +62,10 @@ "message" => "[environments] update of environments on sites"> You may also prefer to use a configuration file to avoid entering the command line options: $ echo ' base_uri: https://api.grid5000.fr/sid - relative_root_uri: /grid5000 + root_path: /grid5000 username: MYLOGIN password: MYPASSWORD ' > ~/somewhere/api.grid5000.fr.yml And then: