github_mirrors/ua-parser-js
3
0
Fork 1
mirror of https://github.com/faisalman/ua-parser-js.git synced 2025-09-27 16:08:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixed readme

Browse Source
This commit is contained in:
Faisalman 2012-03-31 17:15:50 +07:00
parent 294b4e6d58
commit 7cba4e0eca
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
readme.md
View File

@ -4,29 +4,36 @@ JavaScript-based user-agent parser
* Author : Faisalman <<fyzlman@gmail.com>> * Author : Faisalman <<fyzlman@gmail.com>>
* Home : http://faisalman.github.com/ua-parser-js * Home : http://faisalman.github.com/ua-parser-js
* Source : http://github.com/faisalman/ua-parser-js * Source : https://github.com/faisalman/ua-parser-js
* License : GPLv2 * License : GPLv2
## Features ## Features
Get detailed type and version of web browser, layout engine, and operating system. Get detailed type and version of web browser, layout engine, and operating system.
## Methods
* `getBrowser([uastring])`
* `getEngine([uastring])`
* `getOS([uastring])`
* `setUA(uastring)`
## Example ## Example
```html ```html
<script type="text/javascript" src="ua-parser.js"></script> <script type="text/javascript" src="ua-parser.js"></script>
<script type="text/javascript"> <script type="text/javascript">
var parser = new uaparser(); // if no string given as parameter, by default it takes ua string from current window.navigator var p = new UAParser(); // if no string given as parameter, by default it takes ua string from current browser's window.navigator
console.log(parser); console.log(p.result);
/* /*
/// this will print an object structured like this: /// this will print an object structured like this:
{ {
browser: { browser: {
name: "", name: "",
major: "", version: "",
version: "" major: ""
}, },
engine: { engine: {
name: "", name: "",
@ -40,15 +47,11 @@ Get detailed type and version of web browser, layout engine, and operating syste
*/ */
// let's test a custom user-agent string as an example // let's test a custom user-agent string as an example
parser.ua = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2"; p.setUA("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2");
var browser = parser.getBrowser(); console.log(p.result.browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
var engine = parser.getEngine(); console.log(p.result.engine); // {name: "AppleWebKit", version: "535.2"}
var os = parser.getOS(); console.log(p.result.os); // {name: "Ubuntu", version: "11.10"}
console.log(browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
console.log(engine); // {name: "AppleWebKit", version: "535.2"}
console.log(os); // {name: "Ubuntu", version: "11.10"}
</script> </script>
``` ```