Merge pull request video-dev#1540 from video-dev/auto-generated-docs

Auto generated docs + full Hls.js API jsdoc info

.esdoc.json

@@ -0,0 +1,5 @@
+{
+  "source": "./src",
+  "destination": "./docs/html",
+  "plugins": [{"name": "esdoc-standard-plugin"}]
+}

.gitignore

@@ -1,11 +1,18 @@
+# MacOS
 .DS_Store
+
+# npm
 node_modules/*
-bower_components/*
-/streams.js
-lib
 npm-debug.log
+bower_components/*
+
+# NYC
 .nyc_output/
 coverage/
-# ignore JetBrains
+
+# JetBrains
+
 .idea/*
+
+# Build reports
 dist/bundle-analyzer-report.*

README.md

@@ -25,6 +25,12 @@ hls.js is written in [ECMAScript6], and transpiled in ECMAScript5 using [Babel].
 [ECMAScript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
 [Babel]: https://babeljs.io
 
+## API docs and usage guide
+
+* API and code documention: [http://video-dev.github.io/hls.js/docs/html](http://video-dev.github.io/hls.js/docs/html)
+
+* Find a more detailed library usage guide, use-cases and example [here](/docs/API.md)
+
 ## Demo
 
 [http://video-dev.github.io/hls.js/demo](http://video-dev.github.io/hls.js/demo)
@@ -215,11 +221,6 @@ All HLS resources must be delivered with [CORS headers](https://developer.mozill
   - `#EXT-X-PROGRAM-DATE-TIME` (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.2.6)
   - `EXT-X-START:TIME-OFFSET=x` (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.5.2)
 
-
-## Documentation: API and Configuration
-
-hls.js can be configured and controlled easily, click [here](doc/API.md) for details.
-
 ## License
 
   hls.js is released under [Apache 2.0 License](LICENSE)
@@ -245,7 +246,7 @@ npm run lint
 
 ## Design
 
-Click [here](doc/design.md) for details.
+Click [here](/docs/design.md) for details.
 
 ### Tested With
 

demo/index.html

@@ -29,20 +29,27 @@ <h1>
             <img src="https://cloud.githubusercontent.com/assets/616833/19739063/e10be95a-9bb9-11e6-8100-2896f8500138.png"/>
           </a>
         </h1>
-        <h2 class="title">demo</h2>
+
+        <h2 class="title">
+          demo
+        </h2>
+
+        <h3>
+          <a href="../docs/html">API docs | usage guide</a>
+        </h3>
       </header>
     </div>
 
     <div class="main-container">
       <header>
         <p>
-          Test your HLS streams in Chrome, Firefox, IE11, Edge or Safari!
+          Test your HLS streams in all supported browsers (Chrome/Firefox/IE11/Edge/Safari).
         </p>
         <p>
           Advanced controls are available at the bottom of this page.
         </p>
         <p>
-          <b>Looking for a more <i>basic usage</i> example? Go <a href="basic-usage.html">here</a>.</b><br>
+          <b>Looking for a more <i>basic</i> usage example? Go <a href="basic-usage.html">here</a>.</b><br>
         </p>
       </header>
       <div id="controls">