Merge pull request #261 from aknuds1/bugfix/fix-docs

Improve documentation language, fix an example

README.md

@@ -1,5 +1,5 @@
 ## Bowser
-A Browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.
+A browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.
 
 [![Build Status](https://travis-ci.org/lancedikson/bowser.svg?branch=master)](https://travis-ci.org/lancedikson/bowser/) [![Greenkeeper badge](https://badges.greenkeeper.io/lancedikson/bowser.svg)](https://greenkeeper.io/)
 
@@ -15,7 +15,7 @@ The library is made to help to detect what browser your user has and gives you a
 
 _Please, note that this is an alpha version. Check out the [1.x](https://github.com/lancedikson/bowser/tree/v1.x) branch for a stable version._
 
-**Changes of the 2.0**
+**Changes of version 2.0**
 The upcoming 2.0 version has drastically changed API. All available methods can be found in the `docs` folder from now on and on a webpage soon.
 
 # Use cases
@@ -29,7 +29,7 @@ const bowser = require('bowser');
 By default, `require('bowser')` requires the *ES5 version of files*, which
 **do not** include any polyfills.
 
-In case if you don't use your own `babel-polyfill` you may need to have pre-built bundle with all needed polyfills.
+In case you don't use your own `babel-polyfill` you may need to have pre-built bundle with all needed polyfills.
 So, for you it's suitable to require bowser like this: `require('bowser/bundled')`.
 As the result, you get a ES5 version of bowser with `babel-polyfill` bundled together.
 
@@ -37,7 +37,7 @@ You may need to use the source files, so they will be available in the package a
 
 ## Browser props detection
 
-Often we need to pick users' browser properties such as the name, the version, the rendering engine and so on. Here is an example how to make it with Bowser:
+Often we need to pick users' browser properties such as the name, the version, the rendering engine and so on. Here is an example how to do it with Bowser:
 
 ```javascript
 const browser = bowser.getParser(window.navigator.userAgent);

docs/Bowser.html

@@ -230,8 +230,8 @@ All the one-instance stuff is located in Parser class.</p></div>
 
     <h5>Example</h5>
     
-    <pre class="prettyprint"><code>const bowser = new Bowser(window.navigator.userAgent);
+    <pre class="prettyprint"><code>const parser = Bowser.getParser(window.navigator.userAgent);
-bowser.getResult()</code></pre>
+const result = parser.getResult();</code></pre>
 
 
 
@@ -418,7 +418,7 @@ bowser.getResult()</code></pre>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="bowser.js.html">bowser.js</a>, <a href="bowser.js.html#line42">line 42</a>
+        <a href="bowser.js.html">bowser.js</a>, <a href="bowser.js.html#line45">line 45</a>
     </li></ul></dd>
     
 
@@ -469,6 +469,11 @@ bowser.getResult()</code></pre>
 
 
 
+    <h5>Example</h5>
+    
+    <pre class="prettyprint"><code>const result = Bowser.parse(window.navigator.userAgent);</code></pre>
+
+
 
 
     <h5>Parameters:</h5>
@@ -567,7 +572,7 @@ bowser.getResult()</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/Parser.html

@@ -2687,7 +2687,7 @@ Returns <code>undefined</code> when the browser is no described in the checkTree
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/bowser.js.html

@@ -66,8 +66,8 @@ class Bowser {
    * @throws {Error} when UA is not a String
    *
    * @example
-   * const bowser = new Bowser(window.navigator.userAgent);
+   * const parser = Bowser.getParser(window.navigator.userAgent);
-   * bowser.getResult()
+   * const result = parser.getResult();
    */
   static getParser(UA, skipParsing = false) {
     if (typeof UA !== 'string') {
@@ -81,6 +81,9 @@ class Bowser {
    *
    * @param UA
    * @return {ParsedResult}
+   *
+   * @example
+   * const result = Bowser.parse(window.navigator.userAgent);
    */
   static parse(UA) {
     return (new Parser(UA)).getResult();
@@ -102,7 +105,7 @@ export default Bowser;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/global.html

@@ -766,7 +766,7 @@ like <code>&quot;iPhone&quot;</code> or <code>&quot;Kindle Fire HD 7&quot;</code
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/index.html

@@ -50,7 +50,7 @@
 
 
     <section class="readme">
-        <article><h2>Bowser</h2><p>A Browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.</p>
+        <article><h2>Bowser</h2><p>A browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.</p>
 <p><a href="https://travis-ci.org/lancedikson/bowser/"><img src="https://travis-ci.org/lancedikson/bowser.svg?branch=master" alt="Build Status"></a> <a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/lancedikson/bowser.svg" alt="Greenkeeper badge"></a></p>
 <h1>Contents</h1><ul>
 <li><a href="#overview">Overview</a></li>
@@ -60,16 +60,16 @@
 </ul>
 <h1>Overview</h1><p>The library is made to help to detect what browser your user has and gives you a convenient API to filter the users somehow depending on their browsers.</p>
 <p><em>Please, note that this is an alpha version. Check out the <a href="https://github.com/lancedikson/bowser/tree/v1.x">1.x</a> branch for a stable version.</em></p>
-<p><strong>Changes of the 2.0</strong>
+<p><strong>Changes of version 2.0</strong>
 The upcoming 2.0 version has drastically changed API. All available methods can be found in the <code>docs</code> folder from now on and on a webpage soon.</p>
 <h1>Use cases</h1><p>First of all, require the library:</p>
 <pre class="prettyprint source lang-javascript"><code>const bowser = require('bowser');</code></pre><p>By default, <code>require('bowser')</code> requires the <em>ES5 version of files</em>, which
 <strong>do not</strong> include any polyfills.</p>
-<p>In case if you don't use your own <code>babel-polyfill</code> you may need to have pre-built bundle with all needed polyfills.
+<p>In case you don't use your own <code>babel-polyfill</code> you may need to have pre-built bundle with all needed polyfills.
 So, for you it's suitable to require bowser like this: <code>require('bowser/bundled')</code>.
 As the result, you get a ES5 version of bowser with <code>babel-polyfill</code> bundled together.</p>
 <p>You may need to use the source files, so they will be available in the package as well.</p>
-<h2>Browser props detection</h2><p>Often we need to pick users' browser properties such as the name, the version, the rendering engine and so on. Here is an example how to make it with Bowser:</p>
+<h2>Browser props detection</h2><p>Often we need to pick users' browser properties such as the name, the version, the rendering engine and so on. Here is an example how to do it with Bowser:</p>
 <pre class="prettyprint source lang-javascript"><code>const browser = bowser.getParser(window.navigator.userAgent);
 
 console.log(`The current browser name is &quot;${browser.getBrowserName()}&quot;`);
@@ -156,7 +156,7 @@ check if all tests are still passing.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/parser.js.html

@@ -507,7 +507,7 @@ export default Parser;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/utils.js.html

@@ -203,7 +203,7 @@ module.exports = Utils;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Sep 09 2018 15:08:13 GMT+0300 (EEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:31:53 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

src/bowser.js

@@ -23,8 +23,8 @@ class Bowser {
    * @throws {Error} when UA is not a String
    *
    * @example
-   * const bowser = new Bowser(window.navigator.userAgent);
+   * const parser = Bowser.getParser(window.navigator.userAgent);
-   * bowser.getResult()
+   * const result = parser.getResult();
    */
   static getParser(UA, skipParsing = false) {
     if (typeof UA !== 'string') {
@@ -38,6 +38,9 @@ class Bowser {
    *
    * @param UA
    * @return {ParsedResult}
+   *
+   * @example
+   * const result = Bowser.parse(window.navigator.userAgent);
    */
   static parse(UA) {
     return (new Parser(UA)).getResult();