Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matvp91 authored Sep 5, 2024
1 parent b91ce4d commit d6cf73c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,16 @@ Mixwave has a basic video player built on top of HLS.js. Although know that HLS

Like what you see? Considering giving us a ⭐, much appreciated!

Want to get started quickly?
## Getting Started

```shell
cp config.env.example config.env
# Open config.env and change the variables.
docker compose up -d
```

> [!NOTE]
> **Mixwave is in early development, we would appreciate your feedback.**
There's more info in the [Getting Started](https://matvp91.github.io/mixwave/getting-started.html) section in the docs.

## Sponsor

Every bit counts, your contribution means the world to us! Mixwave is a free, side project. Consider sponsoring if it brings you value or you feel like supporting our open source work. ❤️

0 comments on commit d6cf73c

Please sign in to comment.