Skip to content

Commit 4ffd7d7

Browse files
committed
chore: Updated README
1 parent 4429fd8 commit 4ffd7d7

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<p align="center">
1818
<a href="https://superstreamer.xyz">Documentation</a> ·
1919
<a href="https://superstreamer.xyz/guide/getting-started.html">Getting Started</a>
20+
<a href="#contributing">Contributing</a>
2021
</p>
2122

2223
[<img src="./public/button-buy-me-a-coffee.png" width="150" alt="Buy me a coffee button"/>](https://www.buymeacoffee.com/matvp91)
@@ -29,9 +30,8 @@ Superstreamer is a self hostable platform that aims to simplify the complexities
2930
- Transcode your video file into separate quality tracks (eg; 1080p, 720p, 480p).
3031
- Write `HLS CMAF` playlists directly to S3, ready for playback!
3132
- Want to insert a bumper like Netflix? Stitch it as an HLS interstitial on the fly.
32-
- Insert linear ads as interstitials by providing a simple VMAP.
33-
- Use our facade to interact with HLS.js, a heavily simplified wrapper that makes sense for player builders.
34-
- Awesome React components to start building your own player.
33+
- Insert linear ads as interstitials by providing a simple VMAP, or schedule VAST manually.
34+
- Use our player facade, a simplified API alongside [HLS.js](https://github.com/video-dev/hls.js), tailored for developers building a player UI.
3535

3636
Give us a ⭐ if you like our work. Much appreciated!
3737

@@ -40,13 +40,25 @@ Give us a ⭐ if you like our work. Much appreciated!
4040
```shell
4141
# We have prebuilt containers, see docker/docker-compose.yml
4242
cd docker
43-
# Copy the example config
44-
cp ../config.env.example config.env
45-
# Open config.env and change the variables.
43+
# Copy the example .env
44+
cp .env.example .env
45+
# Configure the .env
4646
docker compose up -d
4747
```
4848

49-
Dive into the [Documentation](https://superstreamer.xyz) and do not hesitate to ask questions on [Discord](https://discord.gg/4hXgz9EsF4).
49+
Self-hosting can be challenging, but we aim to make hosting Superstreamer as easy as possible. Check out the [Getting Started](https://superstreamer.xyz/guide/getting-started.html) section for more information. It should get you started in minutes.
50+
51+
## Contributing
52+
53+
We love our contributors! Here's how you can contribute:
54+
55+
- [Open an issue](https://github.com/superstreamerapp/superstreamer/issues) if you believe you've encountered a bug.
56+
- Follow the [local development guide](https://superstreamer.xyz/guide/getting-started.html) to set up your local dev environment.
57+
- Make a [pull request](https://github.com/superstreamerapp/superstreamer/pull) to add new features or fix bugs.
58+
59+
<a href="https://github.com/superstreamerapp/superstreamer/graphs/contributors">
60+
<img width="200" src="https://contrib.rocks/image?repo=superstreamerapp/superstreamer" />
61+
</a>
5062

5163
## Support
5264

docker/.env.example

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
S3_ENDPOINT=
2+
S3_REGION=
3+
S3_ACCESS_KEY=
4+
S3_SECRET_KEY=
5+
S3_BUCKET=
6+
SUPER_SECRET=
7+
PUBLIC_S3_ENDPOINT=

0 commit comments

Comments
 (0)