From d4247de78522ed0b6ae175e32309265e05092515 Mon Sep 17 00:00:00 2001 From: Ken Ellorando Date: Sat, 4 Nov 2023 15:36:32 -0500 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dd3b835a..faddca79 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The project ships with *Icecast* and *Liquidsoap* working out-of-the-box, comple ## 🏃 Get Started -An interactive installation script is provided. Users familiar with Docker can be up and running in ~5 minutes. Alternate methods including manual configuration and Kubernetes deployments are described on the [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation) and in [cadence-k8s](https://github.com/kenellorando/cadence-k8s), respectively. +An interactive installation script is provided. Users familiar with Docker can be up and running in ~5 minutes. Alternate installation methods, including manual configuration and Kubernetes deployments, are respectively described on the [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation) and in [cadence-k8s](https://github.com/kenellorando/cadence-k8s). ### Server Preparation @@ -26,9 +26,9 @@ $ chmod +x ./install.sh $ ./install.sh ``` -You will be prompted to provide the directory path to your music, a stream hostname, a rate limit timeout, a service password, and optional DNS. If you need help figuring out what values to use, refer the [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation#interactive-prompt-guide). Your radio stack will automatically launch and Cadence's web UI will become accessible at `localhost:8080`. +You will be prompted to provide the absolute path to a directory containing your music, a stream hostname, a rate limit timeout, a service password, and optional DNS. If you need help figuring out what values to use, refer to the [Installation Guide](https://github.com/kenellorando/cadence/wiki/Installation#interactive-prompt-guide). Your radio stack will automatically launch and Cadence's web UI will become accessible at `localhost:8080`. -After initial installation, simply run `docker compose pull` to check for container updates, then `docker compose up` to start your station again. Run `./install.sh` again at any time to reconfigure. +After initial installation, simply run `docker compose pull` to check for container updates, then `docker compose up` to start your station again. Run `./install.sh` again at any time to reconfigure. If you make your own changes locally to Cadence's code, run `docker compose up --build` to build and run. ## 🔬 Technical Details From 595194578f4bec6e27a53cfd5b8aed15c92b431a Mon Sep 17 00:00:00 2001 From: Ken Ellorando Date: Thu, 7 Dec 2023 18:51:16 -0600 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index faddca79..ece6b1d6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ **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. Install and deploy in minutes. +The project ships with *Icecast* and *Liquidsoap* working out-of-the-box, made complete with a *Cadence API* providing library search, song request, album artwork, and real-time stream information in a browser UI. Install and deploy in minutes. **See a live demo on [cadenceradio.com](https://cadenceradio.com/)!**