add prominent note about known issues

This commit is contained in:
Tilman Kranz 2024-11-13 07:58:26 +01:00 committed by Tilman Kranz
parent e824b3fb67
commit 3a8a11cc31

View File

@ -1,6 +1,22 @@
# MyPlayer - A Web-MP3-Player with Playlist Support
About:
<div style="border-radius: .25 em; border: 1px solid #caba8a; background-color: #f8e8ba;">
*Note:* MyPlayer is currently undergoing a major rewrite, where it being
updated to the latest version of mediaelement.js. This effort includes porting
the playlist feature to the playlist provided by mediaelement-plugins.
This iteraton of MyPlayer, as present in this GIT repository, has known issues,
especially when changing tracks in the playlist, and not all configuration
demos/source types have been extensively tested (i currently focus on the "m3u"
scenario).
Since i am doing this in my free time, i can not give you a roadmap or timeline
on when the rewrite will be done and the software fully tested. Until then, the
previous version of MyPlayer is available at
<https://tk-sls.de/ref/myplayer.dist.tar.gz>.
</div>
## About
This project provides a JavaScript constructor MyPlayer({...options...}) that can be used
to embed lists of audio files as read from an index document or an M3U into a web document.