From ef9a5b70d3c6aabc8990950f011f96b2f5769c13 Mon Sep 17 00:00:00 2001 From: tilman Date: Mon, 11 Nov 2024 08:24:44 +0100 Subject: [PATCH] small changes --- README.md | 133 +++++++++++++++++++++++++++--------------------------- 1 file changed, 67 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 3270ab3..d092d2c 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,67 @@ -# MyPlayer - A Web-MP3-Player with Playlist Support - -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. - -They will be displayed in a playback GUI with a playlist that can optionally be filled -from the "title" and "artist" values of the files' ID3 tags (v1 and v2 are supported). - -The player is "detachable", meaning it can start in a detached state or the user can open -it in a new window, preventing that playback breaks when the user leaves the page. - -Tested Compatibility: - -MP3: Firefox, Chrome, Internet Exploder -OGG Audio: Firefox, Chrome - -## Usage - -MyPlayer requires jQuery. - -MyPlayer requires the Javascript file from `dist/js` and the CSS and SVG files from `dis/css`. - -Sample inclusions in an HTML document: - -```html - - - - - -``` - -Sample instanciation: - -```html -
- - -``` - -See also [the demo page](demos/index.html) for several examples. - -## Contributing - -* See subdirectory [src](./src) for javascript sources, specifically [player.js](src/player.js). - - Use `src/build.sh` to re-generate the minified script `js/myplayer.min.js`. -* See subdirectory [css](./css) for CSS, specifically [local.js](src/local.js). - - Use `css/build.sh` to re-generate the minified CSS `css/myplayer.min.css`. - -## Author, Copyright and License - -* Author: tilt@linuxfoo.de -* Release: Nov. 10 2024 -* License: MIT - - +# MyPlayer - A Web-MP3-Player with Playlist Support + +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. + +They will be displayed in a playback GUI with a playlist that can optionally be filled +from the "title" and "artist" values of the files' ID3 tags (v1 and v2 are supported). + +The player is "detachable", meaning it can start in a detached state or the user can open +it in a new window, preventing that playback breaks when the user leaves the page. + +Tested Compatibility: + +MP3: Firefox, Chrome, Internet Exploder +OGG Audio: Firefox, Chrome + +## Usage + +MyPlayer requires jQuery. See for example on how to include a recent version. + +MyPlayer requires the Javascript file from `dist/js` and the CSS and SVG files from `dist/css`. + +Sample inclusions in an HTML document: + +```html + + + + + +``` + +Sample instanciation: + +```html +
+ + +``` + +See also [the demo page](demos/index.html) for several examples. + +## Contributing + +* See subdirectory [src](./src) for javascript sources, specifically [player.js](src/player.js). + - Use `src/build.sh` to re-generate the minified script `js/myplayer.min.js`. +* See subdirectory [css](./css) for CSS, specifically [local.js](src/local.js). + - Use `css/build.sh` to re-generate the minified CSS `css/myplayer.min.css`. + +## Author, Copyright and License + +* Author: tilt@linuxfoo.de +* Release: Nov. 10 2024 +* License: MIT + +