README.txt in googleajax-0.2.0 vs README.txt in googleajax-1.0.0

- old
+ new

@@ -1,16 +1,18 @@ = GoogleAjax * Docs: http://googleajax.rubyforge.org -* Code: http://github.com/monki/google_ajax/tree/master +* Code: http://github.com/geemus/googleajax == DESCRIPTION: Ruby wrapper for Google AJAX API REST interfaces(Feeds, Language and Search). == SYNOPSIS: + require "googleajax" + # First, setup referer: GoogleAjax.referer = [your domain name here] # Optionally, you can set an api_key: GoogleAjax.api_key = [your api key here] @@ -51,10 +53,41 @@ GoogleAjax::Search.video('ruby') # Find top 4 web page results for 'Hello world' GoogleAjax::Search.web('Hello world') + # Find top 10 feeds for 'ruby' + GoogleAjax::Feed.find('ruby') + + + +=== Results + +Results from the methods are hashes, automatically converted from the response from Google. + +For example: + + # Find top 4 web page results for 'Hello world' + GoogleAjax::Search.web('Hello world') + # => { :results=>[ + # { :title=>"<b>Hello world</b> program - Wikipedia, the free encyclopedia", + # # ... more data ... + # :url=>"http://en.wikipedia.org/wiki/Hello_world_program" + # }, + # # ... more results + # ], + # :cursor=>{ + # :current_page_index=>0, + # # ... more data ... + # :estimated_result_count=>57800000 + # } + # } + +When possible, the result is simplified: +* Feed.find will return an array instead of {:entries => array} +* Feed.load will return the feed instead of {:feed => feed} + == REQUIREMENTS: * JSON gem to parse responses, or rails == INSTALL: @@ -64,9 +97,10 @@ == LICENSE: (The MIT License) Copyright (c) 2009 {geemus (Wesley Beary)}[http://github.com/geemus] +and {Marc-Andre Lafortune}[http://github.com/marcandre] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,