Skip to content

Commit

Permalink
update url to alexa docs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morgoth committed Jun 22, 2011
1 parent 2d985e0 commit ab61d4d
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.rdoc → README.markdown
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
= Alexa Web Information Service
# Alexa Web Information Service #

== Usage
Alexa.url_info(:access_key_id => 'key', :secret_access_key => 'secret', :host => 'site.com')
# also you can specify option :response_group => 'Rank,ContactInfo' or any other valid group,
# see: http://docs.amazonwebservices.com/AlexaWebInfoService/2005-07-11/
# default response group takes all the available options
## Installation ##

```
gem install alexa
```

## Usage ##

``` ruby
Alexa.url_info(:access_key_id => "key", :secret_access_key => "secret", :host => "site.com")

returns object with methods:
:xml_response, :rank, :data_url, :site_title, :site_description, :language_locale, :language_encoding,
:links_in_count, :keywords, :related_links, :speed_median_load_time, :speed_percentile,
:rank_by_country, :rank_by_city, :usage_statistics
```

NOTE: You can specify option `:response_group => "Rank,ContactInfo"` or any other valid group.
See: [Docs](http://docs.amazonwebservices.com/AlexaWebInfoService/latest/)
Default response group takes all the available options.

You can set configuration in block like this:

``` ruby
Alexa.config do |c|
c.access_key_id = "key"
c.secret_access_key = "secret"
end
```

== Installation
gem install alexa
## Contributors ##

== Contributors
* rmoriz[http://github.com/rmoriz]
* [rmoriz](https://github.com/rmoriz)

== Copyright
## Copyright ##

Copyright (c) 2011 Wojciech Wnętrzak. See LICENSE for details.

0 comments on commit ab61d4d

Please sign in to comment.