README.md in ids_please-2.1.1 vs README.md in ids_please-2.1.2

- old
+ new

@@ -1,17 +1,22 @@ # IDs, please [![Build Status](https://travis-ci.org/gazay/ids_please.svg)](https://codeclimate.com/github/gazay/ids_please) [![ids_please API Documentation](https://www.omniref.com/ruby/gems/ids_please.png)](https://www.omniref.com/ruby/gems/ids_please) +![IDs, Please](https://raw.githubusercontent.com/gazay/ids_please/gh-pages/doc/ids-grey.png) + Grab some hidden in html data from social account page. Get social network IDs or screen names from links to social network accounts. -Sometimes you need to get a social network account name from a link — -to store a screen name in your database instead of parsing the link every time, +Sometimes you need to get a social network account name from a link. To store a screen name in your database instead of parsing the link every time, or maybe to work with these accounts using social network APIs (as I do). Would be easier to have a library that extracts this kind of information from all known social networks for your pleasure. +<a href="https://amplifr.com/?utm_source=ids_please-gem"> +<img src="https://amplifr.com/logo.png" alt="Amplifr" width="162" height="162"> +</a> + <a href="https://evilmartians.com/?utm_source=ids_please"> <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"> </a> ## Installation @@ -26,22 +31,22 @@ gem 'ids_please' ``` ## Usage -This gem works in two modes – you can get real data from social network by http request and page parsing -and you can just parse link to social account to find username/id. Sometimes username from link can't be -used with social network's API, in this case try to get real ID with grab mode. +This gem works in two modes – you can get real data from social network by HTTP request and page parsing +and you can just parse a link to social account to find username/id. Sometimes username from link can't be +used with social network's API, in this case, try to get real ID with grab mode. ### Grabbing data from social account's page -This functionality works through real http requests, so if you feed it with many links – it can take a while. +This functionality works through real HTTP requests, so if you feed it with many links – it can take a while. As Facebook shows data only from public pages and public groups – in most cases you can't gather data from -any profile page. Same thing about private `instagram` accounts, profiles and private groups in `vk`. +any profile page. Same thing about private `Instagram` accounts, profiles and private groups in `vk`. -Also you should provide real urls with right protocols. For example you will not receive any data from `http://facebook.com/Microsoft`, +Also, you should provide real URLs with right protocols. For example, you will not receive any data from `http://facebook.com/Microsoft`, but from `https://facebook.com/Microsoft` you'll receive all data as in example below: ```ruby ids = IdsPlease.new('https://instagram.com/microsoft/', 'https://facebook.com/Microsoft') ids.grab @@ -125,10 +130,14 @@ Special thanks to @ai, @yaroslav, @whitequark ## Notes -Gem named under an impression of an awesome game called [Papers, please](http://papersplea.se/) +Gem named under an impression of an awesome game called [Papers, please](http://papersplea.se/). + +Logo of gem also was inspired by its logo. + +Thanks [@dukope](https://twitter.com/dukope) for allowing me to do this! ## License The MIT License