From 352271706d3870dab3d2c92e538a663f973d49aa Mon Sep 17 00:00:00 2001 From: geoffrey45 Date: Sat, 18 Feb 2023 09:19:07 +0300 Subject: [PATCH] docs: show how to stream to LAN --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 00fadb96..5a4ea8d7 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,14 @@ Options: --version, -v: Show the app version ``` +To stream your music across your local network, use the `--host` flag to run the app in all ports. Like this: + +```sh +swingmusic --host 0.0.0.0 +``` + +The link to access the app will be printed on your terminal. Copy it and open it in your browser. + ### Development This project is broken down into 2. The client and the server. The client comprises of the user interface code. This part is written in Typescript, Vue 3 and SCSS. To setup the client, checkout the [swing client repo ](https://github.com/geoffrey45/swing-client) on GitHub.