Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

update readme

  • Loading branch information...
commit c595757348b7f0b28a6f18bdf80e1619a87531aa 1 parent 9b28c3c
authored September 17, 2009

Showing 2 changed files with 87 additions and 60 deletions. Show diff stats Hide diff stats

  1. 87  README.rdoc
  2. 60  README.txt
87  README.rdoc
Source Rendered
... ...
@@ -0,0 +1,87 @@
  1
+= GoogleAjax
  2
+
  3
+* Docs: http://googleajax.rubyforge.org
  4
+* Code: http://github.com/monki/google_ajax/tree/master
  5
+
  6
+== DESCRIPTION:
  7
+
  8
+Ruby wrapper for Google AJAX API REST interfaces(Feeds, Language and Search).
  9
+
  10
+== SYNOPSIS:
  11
+
  12
+  # First, setup referer: 
  13
+  GoogleAjax.referer = [your domain name here]
  14
+
  15
+  # Optionally, you can set an api_key:
  16
+  GoogleAjax.api_key = [your api key here]
  17
+
  18
+=== Now you are set to go, so here are a few examples:
  19
+
  20
+  # Find top 10 feeds for 'ruby'
  21
+  GoogleAjax::Feed.find('ruby')
  22
+
  23
+  # Load 4 most recent entries from 'http://monki.geemus.com/feed/atom.xml'
  24
+  GoogleAjax::Feed.load('http://monki.geemus.com/feed/atom.xml')
  25
+
  26
+  # Find feed for 'http://monki.geemus.com'
  27
+  GoogleAjax::Feed.lookup('http://monki.geemus.com')
  28
+
  29
+  # Find the language of the string 'Ciao mondo'
  30
+  GoogleAjax::Language.detect('Ciao mondo')
  31
+
  32
+  # Translate 'Hello world' to italian
  33
+  GoogleAjax::Language.translate('Hello world', 'en', 'it')
  34
+
  35
+  # Find top 4 blogs for 'ruby'
  36
+  GoogleAjax::Search.blogs('ruby')
  37
+
  38
+  # Find top 4 books for 'ruby'
  39
+  GoogleAjax::Search.books('ruby')
  40
+
  41
+  # Find top 4 images for 'ruby'
  42
+  GoogleAjax::Search.images('ruby')
  43
+
  44
+  # Find top 4 local results for 'ruby' at latitude 48.8565, longitude 2.3509
  45
+  GoogleAjax::Search.local('ruby', 48.8565, 2.3509)
  46
+
  47
+  # Find top 4 news results for 'ruby'
  48
+  GoogleAjax::Search.news('ruby')
  49
+
  50
+  # Find top 4 video results for 'ruby'
  51
+  GoogleAjax::Search.video('ruby')
  52
+
  53
+  # Find top 4 web page results for 'Hello world'
  54
+  GoogleAjax::Search.web('Hello world')
  55
+
  56
+== REQUIREMENTS:
  57
+
  58
+* JSON gem to parse responses
  59
+
  60
+== INSTALL:
  61
+
  62
+  sudo gem install googleajax --include-dependencies
  63
+
  64
+== LICENSE:
  65
+
  66
+(The MIT License)
  67
+
  68
+Copyright (c) 2009 {geemus (Wesley Beary)}[http://github.com/geemus]
  69
+
  70
+Permission is hereby granted, free of charge, to any person obtaining
  71
+a copy of this software and associated documentation files (the
  72
+'Software'), to deal in the Software without restriction, including
  73
+without limitation the rights to use, copy, modify, merge, publish,
  74
+distribute, sublicense, and/or sell copies of the Software, and to
  75
+permit persons to whom the Software is furnished to do so, subject to
  76
+the following conditions:
  77
+
  78
+The above copyright notice and this permission notice shall be
  79
+included in all copies or substantial portions of the Software.
  80
+
  81
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
  82
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  83
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  84
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  85
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  86
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  87
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
60  README.txt
... ...
@@ -1,60 +0,0 @@
1  
-= GoogleAjax
2  
-
3  
-* Docs: http://googleajax.rubyforge.org
4  
-* Code: http://github.com/monki/google_ajax/tree/master
5  
-
6  
-== DESCRIPTION:
7  
-
8  
-Ruby wrapper to the Google AJAX API REST interfaces(Feeds, Language and Search).
9  
-
10  
-== SYNOPSIS:
11  
-
12  
-* First, setup referer: GoogleAjax.referer = 'http://mydomain.com'
13  
-* Optionally, you can also set an api_key: GoogleAjax.api_key = 'YOUR_API_KEY'
14  
-
15  
-=== Now you are set to go, so a few examples:
16  
-* GoogleAjax::Feed.find('ruby') # Find top 10 feeds for 'ruby'
17  
-* GoogleAjax::Feed.load('http://monki.geemus.com/feed/atom.xml') # Load 4 most recent entries from feed 'http://monki.geemus.com/feed/atom.xml'
18  
-* GoogleAjax::Feed.lookup('http://monki.geemus.com') # Find feed for 'http://monki.geemus.com'
19  
-* GoogleAjax::Language.detect('Ciao mondo') # Find the language of the string 'Ciao mondo'
20  
-* GoogleAjax::Language.translate('Hello world', 'en', 'it') # Translate 'Hello world' to italian
21  
-* GoogleAjax::Search.blogs('ruby') # Find top 4 blogs for 'ruby'
22  
-* GoogleAjax::Search.books('ruby') # Find top 4 books for 'ruby'
23  
-* GoogleAjax::Search.images('ruby') # Find top 4 images for 'ruby'
24  
-* GoogleAjax::Search.local('ruby', 48.8565, 2.3509) # Find top 4 local results for 'ruby' at latitude 48.8565, longitude 2.3509
25  
-* GoogleAjax::Search.news('ruby') # Find top 4 news results for 'ruby'
26  
-* GoogleAjax::Search.video('ruby') # Find top 4 video results for 'ruby'
27  
-* GoogleAjax::Search.web('Hello world') # Find top 4 web page results for 'Hello world'
28  
-
29  
-== REQUIREMENTS:
30  
-
31  
-* JSON gem to parse the responses
32  
-
33  
-== INSTALL:
34  
-
35  
-* sudo gem install googleajax --include-dependencies
36  
-
37  
-== LICENSE:
38  
-
39  
-(The MIT License)
40  
-
41  
-Copyright (c) 2008 monki(Wesley Beary) => monki@geemus.com
42  
-
43  
-Permission is hereby granted, free of charge, to any person obtaining
44  
-a copy of this software and associated documentation files (the
45  
-'Software'), to deal in the Software without restriction, including
46  
-without limitation the rights to use, copy, modify, merge, publish,
47  
-distribute, sublicense, and/or sell copies of the Software, and to
48  
-permit persons to whom the Software is furnished to do so, subject to
49  
-the following conditions:
50  
-
51  
-The above copyright notice and this permission notice shall be
52  
-included in all copies or substantial portions of the Software.
53  
-
54  
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
55  
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
56  
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
57  
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
58  
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
59  
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
60  
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 notes on commit c595757

Please sign in to comment.
Something went wrong with that request. Please try again.