From db63b7013c2c6eda40b1d794d45b4ec126ed2f3a Mon Sep 17 00:00:00 2001
From: Muaz Ahmad <mahmad2000@protonmail.com>
Date: Thu, 24 Aug 2023 14:23:04 +0500
Subject: [PATCH] Added readme

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..070d368
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# hls-player.js
+
+Extremely basic hls player using MediaSource extensions.
+
+Meant to be a custom replacement for hls.js for the stream-server repo
+
+**Not a drop-in replacement nor intended for actual use**. Meant to just be used with the way stream-server handles the http serving.
+
+Currently only works with a single playlist file (not the manifest playlist)
+
+Only works with fragmented mp4, not mpegts. Requires h264 video and mp4a audio. Should be able to parse the codec profile automatically given the above.
+
+Use requires an html5 `<video>` tag. If attributes `autoplay muted` are set, can be used by adding this script: `<script>var x = new VideoLoader('video_tag_id')</script>`. Otherwise add extra code to handle playing, etc.
+
+Simplest export is `cat *.js > /path/to/output.js`. Minify, rename, do whatever extra bits you want.