From f1ca89f186609f173d679430e7f442cf875fe26e Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Tue, 5 Nov 2024 19:40:26 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 265e616..adcac54 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,23 @@ This Python project broadcasts a service on a local network using UDP to enable ## Prerequisites - `python >= 3.11` +- `python-venv` ## Usage -Run the script: +1. Create your `src/.env` file according to your requirements. You can copy `src/.env.dev` as a reference. -```bash -python broadcast.py -``` +2. Run the application: + + ```bash + bash run.sh + ``` + + or, if you are on Windows: + + ```ps + .\start.bat + ``` ## How clients receive the service announcement