From 04a369383dc2aa1e327679cce68482bb24d55a75 Mon Sep 17 00:00:00 2001 From: Triangle717 Date: Tue, 23 Jun 2015 15:18:37 -0400 Subject: [PATCH] Initial README update --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index abbdc88..362c0fb 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,20 @@ [](https://travis-ci.org/gabceb/jquery-browser-plugin) -A jQuery plugin for browser detection. jQuery removed support for browser detection on 1.9.1 so it was abstracted into a jQuery plugin +A jQuery plugin for browser detection. jQuery v1.9.1 dropped support for browser detection, and this project aims to keep the detection up-to-date. ## Installation Include script *after* the jQuery library: +```html + +``` - +Alternatively, you can use the plugin without jQuery by substituting `$.browser` for the global `jQBrowser` object. ## Usage -Returns true if the current useragent is some version of Microsoft's Internet Explorer. Supports all IE versions including IE 12. +Returns true if the current useragent is some version of Microsoft's Internet Explorer. Supports all IE versions including IE 11. $.browser.msie; @@ -24,10 +27,14 @@ Returns true if the current useragent is some version of Firefox $.browser.mozilla; -Reading the browser verion - +Reading the browser version + $.browser.version +You can also examine arbitrary useragents + + jQBrowser.uaMatch(); + ## Things not included in the original jQuery $.browser implementation - Detect specifically Windows, Mac, Linux, iPad, iPhone, iPod, Android, Kindle, BlackBerry, Chrome OS, and Windows Phone useragents @@ -78,7 +85,7 @@ Alternatively, you can detect for generic classifications such as desktop or mob $.browser.versionNumber // Returns 32 as a number ``` -- Support for new useragent on IE 11 and IE 12 +- Support for new useragent on IE 11 - Support for WebKit based Opera browsers - Added testing using PhantomJS and different browser user agents