diff --git a/README.md b/README.md index 3e60c02..b08651e 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,41 @@ FM-DX Webserver is a cross-platform web server designed for FM DXers who want to ## Features - 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. -- 📻 **FM DXing:** Enhance your FM DXing experience with a user-friendly web interface. +- 📻 **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface. - **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd. - **Tuner control:** Control your FM tuner on the go. Phone? Tablet? No problem. +- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users ## Features to be added -- **Password authentication:** Currently anyone can control the tuner. In the near future, we will implement password authentication, by default all the data will be read-only. -- **Low-latency streaming**: Currently planned as a feature similar to WebSDRs to provide a zero-delay audio using your browser. -- **Pre-compiled app version**: Currently planned right after finishing the low-latency streaming feature. +Check here for an up to date task list: https://github.com/NoobishSVK/fm-dx-webserver/issues/3 ## Getting Started Please install **node.js version 21.5.0** or older to make this work. Version >=21.6.0 is currently not working correctly. -1. Clone the repository (or alternatively download it manually): +1. Download or install ffmpeg (optional, but needed if you want the audio stream to work) + + ```bash + Linux (Ubuntu/Debian): + sudo apt install ffmpeg + + Windows: + https://www.geeksforgeeks.org/how-to-install-ffmpeg-on-windows/ + ``` + +2. Clone the repository (or alternatively download it manually): ```bash git clone https://github.com/NoobishSVK/FM-DX-Webserver.git ``` -2. Install dependencies: +3. Nagivate to the fm-dx-webserver folder in your terminal and run this command: ```bash npm install ``` -3. Update your config in userconfig.js: +4. Update your config in userconfig.js: ```js const webServerHost = '0.0.0.0'; // IP of the web server