diff --git a/README.md b/README.md index 9cc65163..cd95dc1e 100644 --- a/README.md +++ b/README.md @@ -31,17 +31,24 @@ Supported Languages Able Player has been translated into the following languages. To add another language, see instructions below under **Contributing**. @@ -51,35 +58,44 @@ Contributing There are many ways to contribute to Able Player, and we welcome and appreciate your help! Here are some options: - If you spot bugs are have feature requests, please submit them to the [Issues][issues] queue. -- If you have code to contribute, please note that all development occurs on the [develop branch][develop]. This is often many commits ahead of the master branch, so please do all development from *develop*, and submit pull requests there. We particularly appreciate help with any issues in the Issues queue that have been flagged with "help wanted". +- If you have code to contribute, please note that all development occurs on the [develop branch][develop]. This is often many commits ahead of the main branch, so please do all development from *develop*, and submit pull requests there. We particularly appreciate help with any issues in the Issues queue that have been flagged with "help wanted". - If you are multilingual, please consider translating Able Player into another language! All labels, prompts, messages, and help text for each language are contained within a single file, contained within the */translations* directory. Compatibility ------------- -*Able Player* has been tested with the following browsers. +During development, *Able Player* is routinely tested with the latest versions of the following browsers. -- Firefox 3.x and higher -- Internet Explorer 10 and higher -- Microsoft Edge all versions -- Google Chrome 7.0 and higher -- Opera 10.63 and higher -- Safari 5.0 on Mac OS X -- Safari on IOS 3.2.2 and higher -- Chrome on Android 4.2 and higher +### Windows +- Chrome +- Firefox +- Edge -Note that mobile browsers have limitations (e.g., volume control and autostart are not supported) +### Mac OS +- Chrome +- Firefox +- Safari +- Opera + +### iOS (iPhone and iPad) +- Safari + +### Android (Google Pixel) +- Chrome +- Firefox + +With the release of version 4.4, we are no longer actively supporting Internet Explorer. Dependencies ------------ *Able Player* has the following third party dependencies: -- *Able Player* uses [jQuery][]. Version 3.2.1 or higher is recommended. +- *Able Player* uses [jQuery][]. Version 3.2.1 or higher is recommended. The example code below uses Google’s hosted libraries; no download required. -- *Able Player* uses [js-cookie][] to store and retrieve user - preferences in cookies. This script is distributed with *Able - Player*. Prior to version 2.3, Able Player used [jquery.cookie][] +- *Able Player* uses [js-cookie][] to store and retrieve user + preferences in cookies. The example code below uses CDN’s hosted libraries; + no download required. Prior to version 2.3, Able Player used [jquery.cookie][] for this same purpose. To install Able Player, copy the following files from the Able Player repo into a folder on your web server: @@ -87,7 +103,6 @@ To install Able Player, copy the following files from the Able Player repo into - button-icons/* - images/* - styles/* (optional, see note below) -- thirdparty/* (includes js-cookie, as mentioned above) - translations/* - LICENSE @@ -102,7 +117,7 @@ Fallback All modern browsers have supported HTML5 media elements for many years. However, there are still older browsers in use that don’t have this support -(e.g., Internet Explorer 9 and earlier). For these, you need to provide fallback content. +(e.g., Internet Explorer 9 and earlier). For these, fallback content should be provided. Prior to version 4.0, *Able Player* used [JW Player][] as a fallback Flash player for older browsers. However, this solution was built specifically on **JW Player 6** @@ -116,9 +131,11 @@ Instead, we recommend providing alternative content as a child of the `