diff --git a/packages/api/README.md b/packages/api/README.md new file mode 100644 index 00000000..994b4028 --- /dev/null +++ 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. \ No newline at end of file diff --git a/packages/app/README.md b/packages/app/README.md new file mode 100644 index 00000000..547d7166 --- /dev/null +++ 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. \ No newline at end of file diff --git a/packages/artisan/README.md b/packages/artisan/README.md new file mode 100644 index 00000000..a1282922 --- /dev/null +++ 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. \ No newline at end of file diff --git a/packages/bolt/README.md b/packages/bolt/README.md new file mode 100644 index 00000000..534e6e51 --- /dev/null +++ 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). \ No newline at end of file diff --git a/packages/stitcher/README.md b/packages/stitcher/README.md new file mode 100644 index 00000000..b5167daa --- /dev/null +++ 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. \ No newline at end of file