Updated documentation

Author: bcpearce

.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 If you found a bug, please report it on the [Issues](https://github.com/bcpearce/homeassistant-gtfs-realtime/issues) page. 
 
-**This feed isn't working**
+### This feed isn't working
 
 While GTFS stands for *General* Transit Feed Specification, there is much variation in the way that a specific provider may configure their feeds. This repository tries to keep a number of feed specs up to date both to confirm compatibility with various providers, and for convenience in setting up the integration in Home Assistant. 
 
@@ -21,13 +21,17 @@ Feeds are checked daily in a GitHub Actions Workflow. You can check the most rec
 
 [![Check GTFS Feed Compatibility](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml/badge.svg)](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml)
 
-**Other Bugs**
+### This Translation Is Not Accurate
+
+This project was developed in English and translations were originally provided by Gemini. If you are fluent in any of the translations provided and find an error, please open an Issue or Pull Request to correct it.
+
+### Other Bugs
 
 This project relies on [gtfs-station-stop](https://github.com/bcpearce/gtfs-station-stop) for grabbing and formatting data feeds into an "arrival clock" style that can be used in Home Assistant. This is consistent with the [Home Assistant Developer Documentation](https://developers.home-assistant.io/docs/creating_platform_index#interfacing-with-devices) recommendations, however it can make bug reporting slightly more complex as it may need to be fixed in the underlying Python library. Note that issues reported for bugs in this integration may be solved with updates to the underlying data provider library instead. 
 
 ## Features
 
-**Adding feeds**
+### Adding feeds
 
 If you have a custom feed that works with this repository, feel free to open a pull request adding it to help out any other users. See [feeds.json](/custom_components/gtfs_realtime/feeds.json) for the schema. 
 - If authentication is required, provide an `auth_hint` or placeholder in the URL. 

README.md

@@ -2,17 +2,15 @@
 ![GTFS Realtime](resources/logo.svg)
 # GTFS Realtime for Home Assistant
 
+Add public transit arrivals and alerts to your Home Assistant Dashboards and Automations.
+
 [![Coverage Status](https://coveralls.io/repos/github/bcpearce/homeassistant-gtfs-realtime/badge.svg?branch=main)](https://coveralls.io/github/bcpearce/homeassistant-gtfs-realtime?branch=main)
 
 [![Check GTFS Feed Compatibility](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml/badge.svg)](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml)
 
 ## Installation
 
-This integration can be installed manually or through [HACS](https://hacs.xyz/). HACS is recommended.
-
-> [!NOTE]
-> As of version 0.4.0, realtime location is available for vechicles in *some* cases. This currently is being tested with NYC Subway locations using a "best guess" method of checking the stop update closest to the current time. 
-> For more about [Realtime Data](#realtime-data-experimental)
+[HACS](https://hacs.xyz/) is recommended for installation. 
 
 #### HACS
 
@@ -28,9 +26,9 @@ Copy files in [custom_components/gtfs_realtime](custom_components/gtfs_realtime/
 
 Once the integration is installed, configure the integration through Settings >> Devices and Services, and use "Add Integration".  Select GTFS Realtime and follow the instructions in the user interface.
 
-You can select a supported provider or configure it manually. A number of GTFS providers are included for convenience in this repository.  
+You can select a supported provider or configure it manually. A number of GTFS providers are included for convenience in this repository. If you have a feed configuration that is not part of the defaults [pull requests are welcome](/.github/CONTRIBUTING.md#adding-feeds).
 
-There is no guarantee that these providers will continue to work with this integration.  A [GitHub Action Workflow](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml) runs to check the status of each feed. 
+There is no guarantee that these providers will continue to work with this integration.  A [GitHub Action Workflow](https://github.com/bcpearce/homeassistant-gtfs-realtime/actions/workflows/feed_compatibility.yaml) runs daily to check the status of each feed. 
 
 ### Realtime Feed URLs
 
@@ -58,15 +56,17 @@ The [resources/NYCT_Bullets](resources/NYCT_Bullets/) folder contains ready-to-u
 
 ### Other Transit Systems
 
-This software may work for other GTFS realtime providers, but has not been tested. There is no guarantee that providers--even if included in this repository--will work--or that changes in provider APIs will not cause breakages. 
+This software may work for other GTFS realtime providers, but has not been tested. There is no guarantee that providers—even if included in this repository—will work—or that changes in provider APIs will not cause breakages. 
 
 ## Frontend
 
 Example frontend card configs can be found in [example](example/).
 
-Simply displaying all entities for a "stop" device provides a train arrival board.
+![sample icon dashboard](example/icon_arrival.jpg)
+
+![sample tile dashboard](example/tile_arrival.jpg)
 
-![sample dashboard](resources/sample.png)
+A tile dashboard can also be generated using the "Generate Arrival Board" action in Developer Tools.
 
 ## Sensors
 
@@ -81,12 +81,9 @@ Raw sensor data is provided in seconds. Minutes are the recommended unit.
 #### Realtime Vehicle Position Data (Experimental)
 
 > [!NOTE] 
-> Available in ≥ 0.4.0 only
+> Available in ≥ 0.4.3 vehicle position data from feeds will be included. Feeds that do not provide vehicle position data use an estimate of the nearest station in trip-update data. 
 
-> [!CAUTION]
-> This does *not* use GTFS Realtime [Vehicle Positions](https://gtfs.org/documentation/realtime/feed-entities/vehicle-positions/) updates. Support may be added in a later release. 
-
-Realtime data is being tested for NYC Subway arrivals and may work with other systems.  This can be viewed by adding the entities to a [Map Card](https://www.home-assistant.io/dashboards/map/).
+Entities can appear on map cards.
 
 ![sample map](resources/realtime-locations.jpg)
 
@@ -102,6 +99,8 @@ Each stop will collect the arrival sensors together as a device. For each static
 
 Services are provided for updating and clearing the static data schedule. During setup, an interval for refreshing this data can be provided.
 
+A service also exists for creating a "Train Arrival Boad" card using multiple tile entities. 
+
 ## GTFS Station Stop
 
 This package utilizes [GTFS Station Stop](https://pypi.org/project/gtfs-station-stop/) to provide updates to Home Assistant sensors. 

custom_components/gtfs_realtime/translations/README.md

@@ -0,0 +1,5 @@
+# Translations
+
+Translations from English were generated by Gemini, and may not be accurate. 
+
+If you are a native speaker of any of the translated languages, Pull Requests and Issue reports correcting the translation are welcome.