README.md in PageRankr-1.0.0 vs README.md in PageRankr-1.1.0
- old
+ new
@@ -1,23 +1,30 @@
# PageRankr
Provides an easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts.
-## Exampes
+## Get it!
+ gem install PageRankr
+
+## Use it!
+
+ require 'page_rankr'
+
### Backlinks
+
Backlinks are the result of doing a search with a query like "link:www.google.com". The number of returned results indicates how many sites point to that url.
-`PageRankr.backlinks('www.google.com', :google, :bing) #=> {:google=>161000, :bing=>208000000}`
+ PageRankr.backlinks('www.google.com', :google, :bing) #=> {:google=>161000, :bing=>208000000}
+ PageRankr.backlinks('www.google.com', :yahoo) #=> {:yahoo=>256300062}
-`PageRankr.backlinks('www.google.com', :yahoo) #=> {:yahoo=>256300062}`
-
Valid search engines are: `:google, :bing, :yahoo, :altavista, :alltheweb, :alexa`.
### Ranks
-`PageRankr.ranks('www.google.com', :alexa, :google) #=> {:alexa=>1, :google=>10}`
+ PageRankr.ranks('www.google.com', :alexa, :google) #=> {:alexa=>1, :google=>10}
+
There are two valid rank trackers supported: `:alexa, :google`.
Alexa ranks are descending where 1 is the most popular. If a site has an alexa rank of 0 then the site is unranked.
Google page ranks are in the range 0-10 where 10 is the most popular. If a site is unindexed then the rank will be -1.
@@ -40,12 +47,15 @@
* <del>AllTheWeb</del>
* <del>Alexa</del>
* <del>Get Google Page Rank</del>
* <del>Implement Hashing Algorithm</del>
* <del>Get Alexa ranking</del>
+* docs
+* tests (need to find way around counts changing)
## Shout Out
Gotta give credit where credits due!
+
* http://github.com/alexmipego/PageRankSharp
* http://snipplr.com/view/18329/google-page-range-lookup/
* http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php
## Copyright
\ No newline at end of file