Skip to content

Commit 04a3693

Browse files
author
Triangle717
committed
Initial README update
1 parent e651dd5 commit 04a3693

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22

33
[![Build Status](https://travis-ci.org/gabceb/jquery-browser-plugin.svg?branch=master)](https://travis-ci.org/gabceb/jquery-browser-plugin)
44

5-
A jQuery plugin for browser detection. jQuery removed support for browser detection on 1.9.1 so it was abstracted into a jQuery plugin
5+
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.
66

77
## Installation
88

99
Include script *after* the jQuery library:
10+
```html
11+
<script src="/path/to/jquery.browser.js"></script>
12+
```
1013

11-
<script src="/path/to/jquery.browser.js"></script>
14+
Alternatively, you can use the plugin without jQuery by substituting `$.browser` for the global `jQBrowser` object.
1215

1316
## Usage
1417

15-
Returns true if the current useragent is some version of Microsoft's Internet Explorer. Supports all IE versions including IE 12.
18+
Returns true if the current useragent is some version of Microsoft's Internet Explorer. Supports all IE versions including IE 11.
1619

1720
$.browser.msie;
1821

@@ -24,10 +27,14 @@ Returns true if the current useragent is some version of Firefox
2427

2528
$.browser.mozilla;
2629

27-
Reading the browser verion
28-
30+
Reading the browser version
31+
2932
$.browser.version
3033

34+
You can also examine arbitrary useragents
35+
36+
jQBrowser.uaMatch();
37+
3138
## Things not included in the original jQuery $.browser implementation
3239

3340
- 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
7885
$.browser.versionNumber // Returns 32 as a number
7986
```
8087

81-
- Support for new useragent on IE 11 and IE 12
88+
- Support for new useragent on IE 11
8289
- Support for WebKit based Opera browsers
8390
- Added testing using PhantomJS and different browser user agents
8491

0 commit comments

Comments
 (0)