Updated README.md

README.md

@@ -11,20 +11,18 @@ This custom integration allows you to monitor public transport departures in Mun
 
 ## Features
 
-- Departure information for Munich public transport
+- Real-time departure information for Munich public transport
 - Configurable through the Home Assistant UI
 - Support for multiple stations
 - Filtering by specific lines and directions
 - Customizable update interval
-- Sensors for next departure and all upcoming departures
+- Sensors for next departure, all upcoming departures, and MVG messages
 - Individual sensors for each selected line and direction
 
 ## Installation
 
 ### HACS (Home Assistant Community Store)
 
-This integration is not yet available in the default HACS repositories. To install it using HACS, follow these steps:
-
 1. Ensure you have [HACS](https://hacs.xyz/) installed in your Home Assistant instance.
 2. In the HACS panel, click on "Integrations".
 3. Click the three dots in the top right corner and select "Custom repositories".
@@ -38,7 +36,7 @@ This integration is not yet available in the default HACS repositories. To insta
 
 ### Manual Installation
 
-1. Download the latest release from the GitHub repository.
+1. Download the latest release from the [GitHub repository](https://github.com/g4bri3lDev/munich_public_transport/releases).
 2. Unzip the download and copy the `munich_public_transport` folder to your `custom_components` directory in your Home Assistant configuration directory.
 3. Restart Home Assistant.
 
@@ -48,19 +46,20 @@ This integration is not yet available in the default HACS repositories. To insta
 2. Click the "+" button to add a new integration.
 3. Search for "Munich Public Transport" and select it.
 4. Follow the configuration steps:
-    - Enter a search query for the station you want to monitor.
-    - Select the specific station from the search results.
-    - Choose the lines you want to track (optional).
-    - Select the directions you want to monitor (optional).
-    - Set the number of departures to display for each line/direction.
-    - Configure the update interval.
+   - Enter a search query for the station you want to monitor.
+   - Select the specific station from the search results.
+   - Choose the lines you want to track (optional).
+   - Select the directions you want to monitor (optional).
+   - Set the number of departures to display for each line/direction.
+   - Configure the update interval.
 
 ## Sensors
 
 The integration creates the following sensors:
 
 - `sensor.next_departure`: Shows the time until the next departure across all selected lines and directions.
 - `sensor.all_departures`: Provides a list of all upcoming departures across all selected lines and directions.
+- `sensor.messages`: Displays relevant MVG messages for the selected lines.
 - Individual sensors for each selected line and direction combination (e.g., `sensor.u3_to_moosach`).
 
 ## Customization
@@ -72,35 +71,39 @@ You can customize the integration's behavior through the Options flow:
 3. Adjust the lines, directions, number of departures, and update interval as needed.
 
 ## Screenshots
+
 ### Selecting a station from the search results
 ![Selecting a station from the search results](screenshots/select_station.png)
+
 ### All added stations
-![ALl added stations](screenshots/entries.png)
+![All added stations](screenshots/entries.png)
+
 ### Device Overview
 ![Device Overview](screenshots/device_overview.png)
+
 ### All Departures
 ![All Departures](screenshots/all_departures.png)
+
 ### A specific line and direction
 ![A specific line and direction](screenshots/line.png)
 
+### Messages for a station
+![Messages for a station](screenshots/messages.png)
 
 ## Troubleshooting
 
 - If you encounter connection errors, ensure that your Home Assistant instance has internet access.
 - Check that the MVG API is operational and not experiencing downtime.
 - For persistent issues, check the Home Assistant logs for more detailed error messages.
+- If you're having trouble with the integration, try increasing the scan interval to reduce the load on the API.
 
 ## Contributing
 
-Contributions to this project are welcome! Please fork the repository and submit a pull request with your improvements.
+Contributions to this project are welcome! Please fork the repository and submit a pull request with your improvements. For major changes, please open an issue first to discuss what you would like to change.
 
 ## License
 
-This project is licensed under the MIT License. See the LICENSE file for details.
-
-## Acknowledgements
-
-- This integration uses the [MVG API](https://github.com/jrester/mvg) by jrester.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
 ## Disclaimer