README.md in PageRankr-4.3.0 vs README.md in PageRankr-4.4.0
- old
+ new
@@ -1,8 +1,8 @@
# PageRankr [](http://travis-ci.org/blatyo/page_rankr)
-Provides an easy way to retrieve Google Page Rank, Alexa Rank, backlink counts, and index counts.
+Provides an easy way to retrieve Google Page Rank, Alexa Rank, backlink counts, index counts and different types of social signals.
I'm looking for co-maintainers. If you'd like to help maintain this project, let me know.
__Note: Version ~> 2.0 and ~> 3.0 used typheous internally which caused memory leak issues and failures on windows. 4.0.0 changes the implementation to use a Net::HTTP based library for better compatability.__
@@ -117,9 +117,35 @@
``` ruby
PageRankr.rank_trackers #=> [:alexa_us, :alexa_global, :alexa_country, :google, :moz_rank, :domain_authority, :page_authority]
```
Alexa ranks are descending where 1 is the most popular. 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 nil.
+
+### Socials
+
+Social signals are a somewhat oversimplified way of telling how popular a site or page currently is.
+
+``` ruby
+ PageRankr.socials('www.google.com', :linked_in) #=> {:linked_in=>1001}
+```
+
+If you don't specify a social tracker, then all of them are used.
+
+``` ruby
+ PageRankr.socials('www.google.com', :google, :linked_in, :pinterest, :stumbled_upon, :twitter, :vk)
+ #=> {:google=>10000, :linked_in=>1001, :pinterest=>75108, :stumple_upon=>255078, :twitter=>21933764, :vk=>3725}
+
+ # this also gives the same result
+ PageRankr.socials('www.google.com')
+ #=> {:google=>10000, :linked_in=>1001, :pinterest=>75108, :stumble_upon=>255078, :twitter=>21933764, :vk=>3725}
+```
+
+Valid social trackers are: `:google, :linked_in, :pinterest, :stumble_upon, :twitter, :vk`. To get this you can do:
+
+``` ruby
+ PageRankr.social_trackers #=> [:google, :linked_in, :pinterest, :stumble_upon, :twitter, :vk]
+```
+
## Use it a la carte!
From versions >= 3, everything should be usable in a much more a la carte manner. If all you care about is google page rank (which I speculate is common) you can get that all by itself: