diff --git a/.eslintrc.js b/.eslintrc.js index d78d772b9b2..d7ee0dabcae 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,5 +1,6 @@ module.exports = { 'env': { + 'browser': true, 'commonjs': true, 'es6': true }, diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c75eb6ff5d2..16c540fa66f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -15,9 +15,9 @@ about: Create a report to help us improve ### Checklist - [ ] The issue observed is not already reported by searching on Github under https://github.com/video-dev/hls.js/issues -- [ ] The issue occurs in the stable client on https://video-dev.github.io/hls.js/stable/demo and not just on my page +- [ ] The issue occurs in the stable client on https://hls-js.netlify.com/demo and not just on my page -- [ ] The issue occurs in the latest client on https://video-dev.github.io/hls.js/latest/demo and not just on my page +- [ ] The issue occurs in the latest client on https://hls-js-latest.netlify.com/demo and not just on my page - [ ] The stream has correct Access-Control-Allow-Origin headers (CORS) - [ ] There are no network errors such as 404s in the browser console when trying to play the stream diff --git a/.gitignore b/.gitignore index c7315c28262..72b0c8ab87b 100644 --- a/.gitignore +++ b/.gitignore @@ -14,5 +14,5 @@ coverage/ # Build /dist -/gh-pages +/netlify /api-docs diff --git a/README.md b/README.md index 19e908698da..98b085fcc44 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ hls.js does not need any player, it works directly on top of a standard HTML```< hls.js is written in [ECMAScript6] (`*.js`) and [TypeScript] (`*.ts`) (strongly typed superset of ES6), and transpiled in ECMAScript5 using the [TypeScript compiler]. -Modules written in TS and plain JS/ES6 can be interdepent and imported/required by each others. +Modules written in TS and plain JS/ES6 can be interdependent and imported/required by each other. To build our distro bundle and serve our development environment we use [Webpack]. @@ -35,21 +35,21 @@ To build our distro bundle and serve our development environment we use [Webpack * [API and usage docs, with code examples](./docs/API.md) -* [Auto-Generated Docs (Latest Release)](http://video-dev.github.io/hls.js/stable/api-docs) -* [Auto-Generated Docs (Master)](http://video-dev.github.io/hls.js/latest/api-docs) +* [Auto-Generated Docs (Latest Release)](https://hls-js.netlify.com/api-docs) +* [Auto-Generated Docs (Master)](https://hls-js-latest.netlify.com/api-docs) -_Note you can access the docs for a particular version using "http://video-dev.github.io/hls.js/v[x.y.z]/api-docs"_ +_Note you can access the docs for a particular version using "[https://github.com/video-dev/hls.js/blob/deployments/README.md](https://github.com/video-dev/hls.js/blob/deployments/README.md)"_ ## Demo ### Latest Release -[https://video-dev.github.io/hls.js/stable/demo](https://video-dev.github.io/hls.js/stable/demo) +[https://hls-js.netlify.com/demo](https://hls-js.netlify.com/demo) ### Master -[https://video-dev.github.io/hls.js/latest/demo](https://video-dev.github.io/hls.js/latest/demo) +[https://hls-js-latest.netlify.com/demo](https://hls-js-latest.netlify.com/demo) ### Specific Version -"http://video-dev.github.io/hls.js/v[x.y.z]/demo" +Find the commit on [https://github.com/video-dev/hls.js/blob/deployments/README.md](https://github.com/video-dev/hls.js/blob/deployments/README.md). ## Getting Started @@ -114,6 +114,7 @@ hls.js is (being) integrated in the following players: - [Videojs](http://videojs.com) through [videojs-hls.js](https://github.com/streamroot/videojs-hls.js). hls.js is integrated as a SourceHandler -- new feature in Video.js 5. - [Videojs](http://videojs.com) through [videojs-contrib-hls.js](https://github.com/Peer5/videojs-contrib-hls.js). Production ready plug-in with full fallback compatibility built-in. - [Fluid Player](https://www.fluidplayer.com) + - [OpenPlayerJS](https://www.openplayerjs.com), as part of the [OpenPlayer project](https://github.com/openplayerjs) ## Chrome/Firefox integration @@ -254,7 +255,7 @@ Pull requests are welcome. Here is a quick guide on how to start. - First, checkout the repository and install required dependencies ```sh git clone https://github.com/video-dev/hls.js.git -# setup dev environement +# setup dev environment cd hls.js npm install # build dist/hls.js, watch file change for rebuild and launch demo page diff --git a/demo/index.html b/demo/index.html index 566ae4de8cf..6605d88c59c 100644 --- a/demo/index.html +++ b/demo/index.html @@ -1,23 +1,16 @@ -
- - - +