README.md in rack-simple_user_agent-0.2.1 vs README.md in rack-simple_user_agent-0.2.2

- old
+ new

@@ -3,26 +3,30 @@ [![Gem Version](https://badge.fury.io/rb/rack-simple_user_agent.svg)](https://badge.fury.io/rb/rack-simple_user_agent) [![Build Status](https://travis-ci.org/toshimaru/rack-simple_user_agent.svg)](https://travis-ci.org/toshimaru/rack-simple_user_agent) [![Coverage Status](https://coveralls.io/repos/github/toshimaru/rack-simple_user_agent/badge.svg)](https://coveralls.io/github/toshimaru/rack-simple_user_agent) [![Code Climate](https://codeclimate.com/github/toshimaru/rack-simple_user_agent/badges/gpa.svg)](https://codeclimate.com/github/toshimaru/rack-simple_user_agent) -Rack::SimpleUserAgent is Rack::Request extension which detects smartphone from user-agent string. There is no complicated logic for the detection, it simply checks if user-agent includes particular string. +Rack::SimpleUserAgent is Rack::Request extension which detects user-agent from request user-agent string. No complicated logic for the detection, it simply(stupidly) checks if user-agent includes particular string. +**[ANNOUNCEMENT] Current `request.from_smartphone?` behavior is going to be changed in the next version. Please don't use `request.from_smartphone?`, use `request.from_smartphone?`, `request.from_android?` instead depending on the use case.** + ## Installation -Add this line to your application's Gemfile: +Add this line to your application's `Gemfile`: ```ruby gem 'rack-simple_user_agent' ``` ## Usage ### on Rails -Bundling 'rack-simple_user_agent' automatically makes Rack::SimpleUserAgent methods available. It's convenient when you use the feature [Action Pack Variants](http://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants) (as of Rails4.1). +Installing `rack-simple_user_agent` automatically makes all detection methods available. These methods are useful when you use the Rails' [Action Pack Variants](http://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants) (as of Rails4.1). +For example, you can use below detection methods in your Rails application. + - `request.from_smartphone?` - `request.from_android?` - `request.from_iphone?` - `request.from_windows_phone?` @@ -47,10 +51,10 @@ ``` request ── from_smartphone? │ ├── from_android? │ │   ├── from_android_mobile? │ │   └── from_android_tablet? - │ ├── from_iphone? + │ ├── from_ios? │ │   ├── from_ipad? │ │   ├── from_iphone? │ │   └── from_ipod? │ └── from_windows_phone? │