From 038ddfcd6e838dedad2245704c58a716c831f0b7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marek=20Farka=C5=A1?= <ardoniceksvk@gmail.com>
Date: Sun, 14 Jan 2024 14:45:41 +0100
Subject: [PATCH] Update README.md

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d493570..cfc4db3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,66 @@
-# fm-dx-webserver
\ No newline at end of file
+# FM-DX Webserver 📻🌐
+
+FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their TEF6686 / F1HD receiver through a web interface.
+
+## 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.
+- 📡 **Cross-Platform:** Works seamlessly across different platforms.
+
+##  Features to be added
+- **Low-latency streaming**: Currently planned a feature similar to WebSDRs.
+- 
+
+## Getting Started
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/your-username/FM-DX-Webserver.git
+    ```
+
+2. Install dependencies:
+
+    ```bash
+    npm install
+    ```
+
+    
+3. Update your config in index.js:
+
+    ```js
+    const webServerHost = '192.168.1.39'; // IP of the web server
+    const webServerPort = 8080; // web server port
+
+    const xdrdServerHost = '192.168.1.15'; // xdrd server iP
+    const xdrdServerPort = 7373; // xdrd server port
+
+    ```
+
+
+4. Start the server:
+
+    ```bash
+    npm start
+    ```
+
+4. Open your web browser and navigate to `http://localhost:3000` to access the web interface.
+
+## Dependencies
+
+This project utilizes the [librdsparser](https://github.com/kkonradpl/librdsparser) library for RDS parsing. Make sure to check out the library for more information.
+
+## Contributing
+
+Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable!
+
+## License
+
+This project is licensed under the [GNU-GPL v3 License](LICENSE.md).
+
+## Acknowledgments
+
+- Thanks to [librdsparser](https://github.com/kkonradpl/librdsparser) for providing the RDS parsing functionality.
+
+Happy DXing! 🎶📡