Update documentation & improve samples

CHANGELOG.md

@@ -1,9 +1,19 @@
-## Media Services 3rd Party Player Samples Changelog
+# Media Services 3rd Party Player Samples Changelog
 
-<a name="0.0.1"></a>
-# 0.0.1 (2020-06-26)
+## Table of contents
 
-*Features*
-* Common Baseline Setup
-* Testing, Samples and Documentation Video.js
-* Testing, Samples and Documentation Shaka
+- [Media Services 3rd Party Player Samples Changelog](#media-services-3rd-party-player-samples-Changelog)
+  - [Table of contents](#table-of-contents)
+  - [Versions](#versions)
+    - [0.0.1 (2020-06-26)](#001-2020-06-26)
+      - [Features](#features)
+
+## Versions
+
+### 0.0.1 (2020-06-26)
+
+#### Features
+
+- Common Baseline Setup
+- Testing, Samples and Documentation Video.js
+- Testing, Samples and Documentation Shaka

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.microsoft.com.
+the rights to use your contribution. For details, visit <https://cla.microsoft.com>.
 
 When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
 a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
@@ -12,61 +12,72 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
 
- - [Code of Conduct](#coc)
- - [Issues and Bugs](#issue)
- - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
+## Table of contents
+
+- [Contributing to Media Services 3rd Party Player Samples](#contributing-to-media-services-3rd-party-player-samples)
+  - [Table of contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [Found an Issue](#found-an-issue)
+  - [Want a Feature](#want-a-feature)
+  - [Submission Guidelines](#submission-guidelines)
+    - [Submitting an Issue](#submitting-an-issue)
+    - [Submitting a Pull Request](#submitting-a-pull-request)
+
+## Code of Conduct
 
-## <a name="coc"></a> Code of Conduct
 Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 
-## <a name="issue"></a> Found an Issue?
+## Found an Issue
+
 If you find a bug in the source code or a mistake in the documentation, you can help us by
-[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
-[submit a Pull Request](#submit-pr) with a fix.
+[submitting an issue](#submitting-an-issue) to the GitHub Repository. Even better, you can
+[submit a Pull Request](#submitting-a-pull-request) with a fix.
 
-## <a name="feature"></a> Want a Feature?
-You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
+## Want a Feature
+
+You can *request* a new feature by [submitting an issue](#submitting-an-issue) to the GitHub
 Repository. If you would like to *implement* a new feature, please submit an issue with
 a proposal for your work first, to be sure that we can use it.
 
-* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+- **Small Features** can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request).
+
+## Submission Guidelines
 
-## <a name="submit"></a> Submission Guidelines
+### Submitting an Issue
 
-### <a name="submit-issue"></a> Submitting an Issue
 Before you submit an issue, search the archive, maybe your question was already answered.
 
 If your issue appears to be a bug, and hasn't been reported, open a new issue.
 Help us to maximize the effort we can spend fixing issues and adding new
 features, by not reporting duplicate issues.  Providing the following information will increase the
 chances of your issue being dealt with quickly:
 
-* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
-* **Version** - what version is affected (e.g. 0.1.2)
-* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
-* **Browsers and Operating System** - is this a problem with all browsers?
-* **Reproduce the Error** - provide a live example or a unambiguous set of steps
-* **Related Issues** - has a similar issue been reported before?
-* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+- **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
+- **Version** - what version is affected (e.g. 0.1.2)
+- **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
+- **Browsers and Operating System** - is this a problem with all browsers?
+- **Reproduce the Error** - provide a live example or a unambiguous set of steps
+- **Related Issues** - has a similar issue been reported before?
+- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
   causing the problem (line of code or commit)
 
-You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
+You can file new issues by providing the above information at the corresponding repository's issues link: <https://github.com/[organization-name>]/[repository-name]/issues/new].
+
+### Submitting a Pull Request
 
-### <a name="submit-pr"></a> Submitting a Pull Request (PR)
 Before you submit your Pull Request (PR) consider the following guidelines:
 
-* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
+- Search the repository (<https://github.com/[organization-name>]/[repository-name]/pulls) for an open or closed PR
   that relates to your submission. You don't want to duplicate effort.
 
-* Make your changes in a new git fork:
+- Make your changes in a new git fork:
 
-* Commit your changes using a descriptive commit message
-* Push your fork to GitHub:
-* In GitHub, create a pull request
-* If we suggest changes then:
-  * Make the required updates.
-  * Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
+- Commit your changes using a descriptive commit message
+- Push your fork to GitHub:
+- In GitHub, create a pull request
+- If we suggest changes then:
+  - Make the required updates.
+  - Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
 
     ```shell
     git rebase master -i

LICENSE.md

@@ -1,3 +1,6 @@
+
+# License
+
     MIT License
 
     Copyright (c) Microsoft Corporation.

README.md

@@ -11,6 +11,7 @@ urlFragment: "media-services-3rdparty-player-samples"
 # Media Services 3rd Party Player Samples
 
 ## Overview
+
 This repository contains samples, documentation and platform/browser support matrix for using popular 3rd party player frameworks that support HLS and/or MPEG-DASH delivery from Azure Media Services (AMS).
 
 This guidance also includes the steps needed to configure and play Live and VOD content from Azure Media Services with several 3rd party video players. There are two main components to this repository:
@@ -23,8 +24,6 @@ This guidance also includes the steps needed to configure and play Live and VOD
 
 ## Contents
 
-Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.
-
 | File/folder         | Description                                |
 |---------------------|--------------------------------------------|
 | `.github`           | Folder with github workflows               |
@@ -36,3 +35,44 @@ Outline the file contents of the repository. It helps users navigate the codebas
 | `CONTRIBUTING.md`   | Guidelines for contributing to the sample. |
 | `LICENSE`           | The license for the sample.                |
 | `README.md`         | This README file.                          |
+
+## Prerequisites
+
+To run the setup scripts you need to install the following tools
+
+- [Azure CLI 2.8.0+](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)
+- [PowerShell 5.1+](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-7)
+
+## Setup
+
+To setup these samples first you need to run the setup scripts. For a detailed guide on how to run them go to [Setup](/setup).
+
+## Running the sample
+
+Once you have created all the content in Azure Media Services continue with our guides for each Player:
+
+- [Video.js](/src/video.js)  or
+- [Shaka Player](/src/shaka)
+
+## Key concepts
+
+This project uses Azure CLI in PowerShell scripts to generate content in Azure Media Services, it also provides HTML/JS sample implementations to test this content and test results for each combination of browser, format and content.
+
+For test results plase check
+
+- [Video.js](/docs/video.js#test-results)
+- [Shaka Player](/docs/shaka#test-results)
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.