Readme.rdoc in amazon-ecs-2.3.0 vs Readme.rdoc in amazon-ecs-2.3.1
- old
+ new
@@ -1,20 +1,16 @@
== amazon-ecs
-Generic Product Advertising Ruby API using Nokogiri. Uses Response and
-Element wrapper classes for easy access to the REST API XML output.
+Amazon ECS is a generic Ruby wrapper to access Amazon Product Advertising API.
-It is generic, so you can easily extend <tt>Amazon::Ecs</tt> to support
-other not implemented REST operations; and it is also generic because it just wraps around
-Nokogiri element object, instead of providing one-to-one object/attributes to XML elements map.
+You can easily extend the library to support any of the operations supported by the API.
-The idea is as the API evolves, there is a change in REST XML output structure,
-no updates will be required on <tt>amazon-ecs</tt> gem,
-instead you just need to update the element path.
+The library wraps around Nokogiri element object. It provides an easy access to the XML response
+structure through an XML path instead of an object attribute. The idea is the API evolves,
+there will be changes to the XML schema. With Amazon ECS, your code will still work, only
+the XML path needs to be updated.
-For HPricot dependency implementation, please install 1.2.x version or checkout v1.2 branch.
-
== INSTALLATION
$ gem install amazon-ecs
== EXAMPLE
@@ -116,27 +112,19 @@
end
end
Amazon::Ecs.other_operation('[item_id]', :param1 => 'abc', :param2 => 'xyz')
-Refer to Amazon Product Advertising API documentation for more information
-on other valid operations, request parameters and the XML response output:
+Refer to the Amazon Product Advertising API documentation for more information:
https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
-To get a sample of Amazon REST XML response output, use AWSZone.com scratch pad:
-http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
-
== SOURCE CODES
* http://github.com/jugend/amazon-ecs
== CREDITS
-Thanks to Dan Milne (http://da.nmilne.com/) for the signed request patch.
+Thanks to Dan Milne and Bryan Housel for the pull requests.
-Thanks to Bryan Housel (https://github.com/bhousel/amazon-ecs) for the initial Nokogiri patch
-
== LICENSE
-(The MIT License)
-
-Copyright (c) 2011 Herryanto Siatono, http://www.siatono.com
\ No newline at end of file
+[The MIT License]