chore: Added a bunch of readme

superstreamerapp · Dec 9, 2024 · b2dcca3 · b2dcca3
1 parent aea2d1c
commit b2dcca3
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/packages/api/README.md b/packages/api/README.md
@@ -0,0 +1,8 @@
+# @superstreamer/api
+
+The main API for:
+
+- Asset management.
+- Start transcode, package (or pipeline) jobs.
+- Get a job by id, read status.
+- Get storage info, such as transcode results.
diff --git a/packages/app/README.md b/packages/app/README.md
@@ -0,0 +1,3 @@
+# @superstreamer/app
+
+The app serves as a user-friendly dashboard, enabling interaction with Superstreamer through its API.
diff --git a/packages/artisan/README.md b/packages/artisan/README.md
@@ -0,0 +1,5 @@
+# @superstreamer/artisan
+
+The actual workers, this is where ffmpeg, ffprobe and the packager run.
+
+We rely on [bullmq](https://www.npmjs.com/package/bullmq) as queue. Artisan will pick an available job from the queue and get to work.
diff --git a/packages/bolt/README.md b/packages/bolt/README.md
@@ -0,0 +1,3 @@
+# bolt
+
+An **internal** package that manages the different queues. This package is mainly shared between the API (pushing a job to the queue) and Artisan (consuming a job, does the actual work).
diff --git a/packages/stitcher/README.md b/packages/stitcher/README.md
@@ -0,0 +1,6 @@
+# @superstreamer/stitcher
+
+A real-time playlist manipulator, able to proxy HLS playlists and insert interstitials on the fly.
+
+- Filtering of the master playlist.
+- Resolves a VMAP or a VAST and adds the ad as part of an interstitial.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# @superstreamer/app

		The app serves as a user-friendly dashboard, enabling interaction with Superstreamer through its API.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# bolt

		An internal package that manages the different queues. This package is mainly shared between the API (pushing a job to the queue) and Artisan (consuming a job, does the actual work).