Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kenellorando authored Mar 28, 2023
1 parent 1396ca0 commit 34db796
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/17265041/226766588-30a7bb71-490b-4182-a6b0-b22409f6ec3b.png" width="300">
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/17265041/226766586-1a55554e-33a4-4fb2-8259-49359f3f3525.png" width="300">
<img alt="Cadence logo.">
</picture>
<p align="center"><b>All-in-one, self-hosted web radio suite.</b></p>
<div align="center"><img align="center" src="https://user-images.githubusercontent.com/17265041/219263637-6971ce33-209a-4eb5-b67e-547f271dc3c8.png" height="300" ></div>
</p>

## 📻 About

**Cadence** (or *CadenceRadio*) is an all-in-one internet radio suite with library search, song request, album artwork, and real-time stream information in a browser UI. Simply run an interactive installation script, provide some music, and enjoy!
<img align="right" src="https://user-images.githubusercontent.com/17265041/219263637-6971ce33-209a-4eb5-b67e-547f271dc3c8.png" width="450" >

**Cadence** (or *CadenceRadio*) is an all-in-one internet radio suite.

The project ships with *Icecast* and *Liquidsoap* working out-of-the-box, complete with library search, song request, album artwork, and real-time stream information in a browser UI. Simply run an interactive installation script, provide some music, and enjoy!

**See a live demo on [cadenceradio.com](https://cadenceradio.com/)!**

Expand All @@ -25,12 +19,14 @@ chmod +x ./install.sh
./install.sh
```

You will be prompted to provide a music directory path, a stream hostname, a rate limit timeout, a service password, and optional DNS. Your radio stack will automatically launch and Cadence's web UI will become accessible at `localhost:8080`.
You will be prompted to provide a music directory path, a stream hostname, a rate limit timeout, a service password, and optional DNS. Your radio stack will automatically launch and Cadence's web UI will become accessible at `localhost:8080`. That's all there is to it!

After initial installation, simply run `docker compose up` to start your station. Run `./install.sh` again at any time to reconfigure.

If you can't run a shell script for any reason, or if the scripted install was too easy for you, alternative installation methods including fully-manual configuration and even Kubernetes deployment steps are provided on the [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation).

After initial installation, simply run `docker compose up` to start your station. Run `./install.sh` again at any time to reconfigure.
## 🦔 Resources

## 🦔 Documentation
If you're interested in implementation details, [Cadence: Self-Hosted Web Radio Suite](https://kenellorando.notion.site/Cadence-Self-Hosted-Web-Radio-Suite-d1f0184b5eeb4882a3d6f78d582b2de6) does a dive into how a typical web radio works and the value Cadence provides.

- [Cadence: Self-Hosted Web Radio Suite](https://kenellorando.notion.site/Cadence-Self-Hosted-Web-Radio-Suite-d1f0184b5eeb4882a3d6f78d582b2de6)
- [API Reference](https://github.com/kenellorando/cadence/wiki/API-Reference)
- [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation)
Cadence's GitHub Wiki also hosts an [API Reference](https://github.com/kenellorando/cadence/wiki/API-Reference) with complete request/response details, useful for anyone developing custom scripts or clients for their station.

0 comments on commit 34db796

Please sign in to comment.