Restructure Readme.md (#3219)

Dash-Industry-Forum · Apr 17, 2020 · 2cce63d · 2cce63d
1 parent 9b5aacb
commit 2cce63d
Showing 1 changed file with 47 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -14,79 +14,31 @@ If your goal is to improve or extend the code and contribute back to this projec
 
 All new work should be in the development branch. Master is now reserved for tagged builds.
 
-## Documentation
-Before you get started, please read the Dash.js v3.0 Migration Document found [here](https://github.com/Dash-Industry-Forum/dash.js/wiki/Migration-3.0)
-
-Full [API Documentation](http://cdn.dashjs.org/latest/jsdoc/module-MediaPlayer.html) is available describing all public methods, interfaces, properties, and events.
-
-For help, join our [Slack channel](https://dashif-slack.azurewebsites.net), our [email list](https://groups.google.com/d/forum/dashjs) and read our [wiki](https://github.com/Dash-Industry-Forum/dash.js/wiki).
-
-## Reference players
-The released [pre-built reference players](http://reference.dashif.org/dash.js/) are publicly accessible if you want direct access without writing any Javascript.
-
-Multiple dash.js samples covering a wide set of common use cases can be found in the project's sample folder hosted [here](http://reference.dashif.org/dash.js/latest/samples/index.html).
-
-The [nightly build of the /dev branch reference player](http://reference.dashif.org/dash.js/nightly/samples/dash-if-reference-player/index.html), is pre-release but contains the latest fixes. It is a good place to start if you are debugging playback problems.
-
-A nightly build of the latest minified files are also available: [dash.all.min.js](http://reference.dashif.org/dash.js/nightly/dist/dash.all.min.js) and its debug version  [dash.all.debug.js](http://reference.dashif.org/dash.js/nightly/dist/dash.all.debug.js).
-
+## Demo and reference players
 All these reference builds and minified files are available under both http and https.
 
-## Quick Start for Users
-If you just want a DASH player to use and don't need to see the code or commit to this project, then follow the instructions below. If you are a developer and want to work with this code base, then skip down to the "Quick Start for Developers" section.
+### Samples
+Multiple [dash.js samples](https://reference.dashif.org/dash.js/latest/samples/index.html) covering a wide set of common use cases.
 
-Put the following code in your web page
-```
-<script src="https://cdn.dashjs.org/latest/dash.all.min.js"></script>
-...
-<style>
-    video {
-       width: 640px;
-       height: 360px;
-    }
-</style>
-...
-<body>
-   <div>
-       <video data-dashjs-player autoplay src="https://dash.akamaized.net/envivio/EnvivioDash3/manifest.mpd" controls></video>
-   </div>
-</body>
-```
-Then place your page under a web server (do not try to run from the file system) and load it via http in a MSE-enabled browser. The video will start automatically. Switch out the manifest URL to your own manifest once you have everything working. If you prefer to use the latest code from this project (versus the last tagged release) then see the "Quick Start for Developers" section below.
+### Reference players
+The released [pre-built reference players ](http://reference.dashif.org/dash.js/) if you want direct access without writing any Javascript.
 
-View the /samples folder for many other examples of embedding and using the player. If you are interested in captioning support, which requires some additional UI elements, then please view the [captioning examples](https://github.com/Dash-Industry-Forum/dash.js/tree/development/samples/captioning).
+The [nightly build of the /dev branch reference player](http://reference.dashif.org/dash.js/nightly/samples/dash-if-reference-player/index.html), is pre-release but contains the latest fixes. It is a good place to start if you are debugging playback problems.
 
 
-## Quick Start for Developers
+### CDN hosted files
+The latest minified files have been hosted on a global CDN and are free to use in production: 
 
-1. Install Core Dependencies
-    * [install nodejs](http://nodejs.org/)
-    * [install grunt](http://gruntjs.com/getting-started)
-        * ```npm install -g grunt-cli```
-2. Checkout project repository (default branch: development)
-    * ```git clone https://github.com/Dash-Industry-Forum/dash.js.git```
-3. Install dependencies
-    * ```npm install```
-4. Build, watch file changes and launch samples page, which has links that point to reference player and to other examples (basic examples, captioning, ads, live, etc).
-    * ```grunt dev```
+- [dash.all.min.js](http://cdn.dashjs.org/latest/dash.all.min.js) 
+- [dash.all.debug.js](http://cdn.dashjs.org/latest/dash.all.debug.js) 
 
 
-### Other Grunt Tasks to Build / Run Tests on Commandline.
+## Documentation
+Full [API Documentation](http://cdn.dashjs.org/latest/jsdoc/module-MediaPlayer.html) is available describing all public methods, interfaces, properties, and events.
 
-1. Individual tasks:
-    * Quickest build
-        * ```grunt debug```
-    * Lint
-        * ```grunt lint```
-    * Run unit tests
-        * ```grunt test```
-    * Build distribution files (minification included)
-        * ```grunt dist```
-    * Build distribution files, lint, run unit tests and generate documentation
-        * ```grunt release```
-2. GruntFile.js default task (equivalent to ```grunt dist && grunt test```)
-    * ```grunt```
+For help, join our [Slack channel](https://dashif-slack.azurewebsites.net), our [email list](https://groups.google.com/d/forum/dashjs) and read our [wiki](https://github.com/Dash-Industry-Forum/dash.js/wiki).
 
+If you are migrating from dash.js v2.x to dash.js v3.x please read the migration document found [here](https://github.com/Dash-Industry-Forum/dash.js/wiki/Migration-3.0).
 
 
 ## Getting Started
@@ -191,6 +143,39 @@ When it is all done, it should look similar to this:
 </html>
 ```
 
+## Quick Start for Developers
+
+1. Install Core Dependencies
+    * [install nodejs](http://nodejs.org/)
+    * [install grunt](http://gruntjs.com/getting-started)
+        * ```npm install -g grunt-cli```
+2. Checkout project repository (default branch: development)
+    * ```git clone https://github.com/Dash-Industry-Forum/dash.js.git```
+3. Install dependencies
+    * ```npm install```
+4. Build, watch file changes and launch samples page, which has links that point to reference player and to other examples (basic examples, captioning, ads, live, etc).
+    * ```grunt dev```
+
+
+### Other Grunt Tasks to Build / Run Tests on Commandline.
+
+1. Individual tasks:
+    * Quickest build
+        * ```grunt debug```
+    * Lint
+        * ```grunt lint```
+    * Run unit tests
+        * ```grunt test```
+    * Build distribution files (minification included)
+        * ```grunt dist```
+    * Build distribution files, lint, run unit tests and generate documentation
+        * ```grunt release```
+2. GruntFile.js default task (equivalent to ```grunt dist && grunt test```)
+    * ```grunt```
+
+### License
+dash.js is released under [BSD license](https://github.com/Dash-Industry-Forum/dash.js/blob/development/LICENSE.md)
+
 ### Tested With
 
 [<img src="https://cloud.githubusercontent.com/assets/7864462/12837037/452a17c6-cb73-11e5-9f39-fc96893bc9bf.png" alt="Browser Stack Logo" width="300">](https://www.browserstack.com/)