Skip to content

Commit

Permalink
Add Table of Contents to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean-Der committed Dec 16, 2023
1 parent 3b3416d commit a2fe3f1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Discord](https://img.shields.io/discord/1162823780708651018?logo=discord)](https://discord.gg/An5jjhNUE3)

- [What is Broadcast Box](#what-is-broadcast-box)
- [Using](#using)
+ [Broadcasting](#broadcasting)
+ [Broadcasting (Gstreamer, CLI)](#broadcasting--gstreamer--cli-)
+ [Playback](#playback)
- [Running](#running)
+ [Installing Dependencies](#installing-dependencies)
+ [Configuring](#configuring)
+ [Local Development](#local-development)
+ [Production](#production)
+ [Docker](#docker)
- [Design](#design)

## What is Broadcast Box
Broadcast Box lets you broadcast to others in sub-second time. It was designed
to be simple to use and easily modifiable. We wrote Broadcast Box to show off some
of the cutting edge tech that is coming to the broadcast space.
Expand Down Expand Up @@ -207,3 +221,4 @@ The backend exposes two endpoints.
* `/api/whip` - Start a WHIP Session. WHIP broadcasts video via WebRTC.
* `/api/whep` - Start a WHEP Session. WHEP is video playback via WebRTC.
* `/api/status` - Status of the all active WHIP streams

0 comments on commit a2fe3f1

Please sign in to comment.