README.md in PageRankr-1.7.0 vs README.md in PageRankr-1.7.1
- old
+ new
@@ -3,11 +3,11 @@
Provides an easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts.
Check out a little [web app][1] I wrote up that uses it or look at the [source][2].
[1]: http://isitpopular.heroku.com
-[2]: http://github.com/blatyo/is_it_popular
+[2]: https://github.com/blatyo/is_it_popular
## Get it!
gem install PageRankr
@@ -59,19 +59,21 @@
PageRankr.index_trackers #=> [:alexa, :alltheweb, :altavista, :bing, :google, :yahoo]
### Ranks
- PageRankr.ranks('www.google.com', :alexa, :google) #=> {:alexa=>{:us=>1, :global=>1}, :google=>10}
+__Note: Compete only accepts urls in the form of "google.com" and not "www.google.com". If the latter is given, a value of 0 will be returned. This will be fixed in version 2 of PageRankr.__
+ PageRankr.ranks('google.com', :alexa, :google, :compete) #=> {:alexa=>{:us=>1, :global=>1}, :google=>10, :compete=>1}
+
# this also gives the same result
- PageRankr.ranks('www.google.com') #=> {:alexa=>{:us=>1, :global=>1}, :google=>10}
+ PageRankr.ranks('google.com') #=> {:alexa=>{:us=>1, :global=>1}, :google=>10, :compete=>1}
You can also use the alias `rank` instead of `ranks`.
-There are two valid rank trackers supported: `:alexa, :google`. To get this you can do:
+There are three valid rank trackers supported: `:alexa, :google, :compete`. To get this you can do:
- PageRankr.rank_trackers #=> [:alexa, :google]
+ PageRankr.rank_trackers #=> [:alexa, :google, :compete]
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.
## Fix it!
@@ -128,17 +130,19 @@
* Use [Typhoeus](https://github.com/pauldix/typhoeus) to improve speed when requesting multiple ranks and/or backlinks
* Configuration
* Optionally use API keys
## Contributors
-* [Druwerd](http://github.com/Druwerd) - Use Google Search API instead of scraping.
+* [Druwerd](https://github.com/Druwerd) - Use Google Search API instead of scraping.
+* [Iteration Labs](https://github.com/iterationlabs) - Compete rank tracker and domain indexes.
## Shout Out
Gotta give credit where credits due!
-* [http://github.com/alexmipego/PageRankSharp](http://github.com/alexmipego/PageRankSharp)
-* [http://snipplr.com/view/18329/google-page-range-lookup/](http://snipplr.com/view/18329/google-page-range-lookup/)
-* [http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php](http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php)
+Original inspiration from:
+* [PageRankSharp](https://github.com/alexmipego/PageRankSharp)
+* [Google Page Range Lookup/](http://snipplr.com/view/18329/google-page-range-lookup/)
+* [AJAX PR Checker](http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php)
## Copyright
Copyright (c) 2010 Allen Madsen. See LICENSE for details.
\ No newline at end of file