Updated readme, Created language specific docs

Closes #105

README.md

@@ -18,27 +18,8 @@ This adapter integrates the ODL (Ortsdosisleistung / Ambient Dose Rate) values o
 
 For more information about the ambient dose rate in germany visit <https://odlinfo.bfs.de/>.
 
----
-
-## Die aktuelle Umweltradioaktivität in ioBroker
-
-Dieser Adapter integriert die ODL (Ortsdosisleistung) Messwerte von ausgewählten Messstellen des [Bundesamtes für Strahlenschutz (BfS)](https://www.bfs.de/) in ioBroker.
-
-Das bundesweite Messnetz des BfS umfasst rund 1700 ortsfeste Messstellen, die permanent die vor Ort aktuelle Gamma-Umweltradioaktivität (Ortsdosisleistung) erfassen und aufzeichnen. Die gewonnenen Messdaten werden vom BfS gesammelt, ausgewertet und öffentlich unter der _Datenlizenz Deutschland_ zur Verfügung gestellt.
-
-Für weitere Informationen zur ODL siehe <https://odlinfo.bfs.de/>.
-
-Dieser Adapter läd die aktuellen 1-Stunden-Mittelwerte der Messdaten direkt über die [offizielle Datenschnittstelle des BfS](https://odlinfo.bfs.de/ODL/DE/service/datenschnittstelle/datenschnittstelle_node.html). Das BfS ist Urheber der vom Adapter verwendeten Daten.  
-Alle Daten werden in unveränderter Form, so wie sie von der Datenschnittstelle geliefert werden, vom Adapter bereitgestellt.
-
-Wird ein aktivierter History-Adapter (_history_, _influxdb_ oder _sql_) für einen Werte-State erkannt, dann werden gegebenenfalls in der Historie fehlende Datenpunkte durch den Adapter automatisch nachgetragen, sodass sich vollständige Zeitreihen ergeben.
-
-Die aktuellen Messdaten werden von dem Adapter standardmäßig im Stundentakt aktualisiert. Ein geringerer Aktualisierungsintervall ist meist nicht sinnvoll, da die zu Grunde liegenden Messdaten auf dem BfS-Server (abhängig von der Messstelle) größtenteils stündlich aktualisiert werden.  
-Beim ersten Start des Adapters wird automatisch der Zeitpunkt für den Abruf der Daten angepasst, sodass nicht alle Installation die Daten zur gleichen Zeit abrufen und die Datenschnittstelle des BfS nicht unnötig belastet wird.
-
-[![Screenshot 1](./docs/ioBroker-odl-01.png)](./docs/ioBroker-odl-01.png)
-
-[![Screenshot 2](./docs/ioBroker-odl-02.png)](./docs/ioBroker-odl-02.png)
+* [English description](./docs/en/README.md)
+* [German description](./docs/de/README.md)
 
 ---
 
@@ -50,6 +31,8 @@ Beim ersten Start des Adapters wird automatisch der Zeitpunkt für den Abruf der
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### **WORK IN PROGRESS**
+
 ### 4.0.0 (2024-09-23)
 
 * (crycode-de) Node.js >= 18, Admin >= 6.17, js-contoller >= 5.0.19 are required

docs/de/README.md

@@ -0,0 +1,24 @@
+# ioBroker.odl
+
+![Logo](../../admin/odl.png)
+
+## Die aktuelle Umweltradioaktivität in ioBroker
+
+Dieser Adapter integriert die ODL (Ortsdosisleistung) Messwerte von ausgewählten Messstellen des [Bundesamtes für Strahlenschutz (BfS)](https://www.bfs.de/) in ioBroker.
+
+Das ODL-Messnetz des BfS überwacht mit rund 1.700 Messsonden rund um die Uhr die Strahlenbelastung durch natürliche Radioaktivität in der Umwelt. Das Messnetz hat eine wichtige Frühwarnfunktion, um erhöhte Strahlung durch radioaktive Stoffe in der Luft in Deutschland schnell zu erkennen.  
+Die gewonnenen Messdaten werden vom BfS gesammelt, ausgewertet und öffentlich unter der _Datenlizenz Deutschland_ zur Verfügung gestellt.
+
+Für weitere Informationen zur ODL siehe <https://odlinfo.bfs.de/>.
+
+Dieser Adapter läd die aktuellen 1-Stunden-Mittelwerte der Messdaten direkt über die [offizielle Datenschnittstelle des BfS](https://odlinfo.bfs.de/ODL/DE/service/datenschnittstelle/datenschnittstelle_node.html). Das BfS ist Urheber der vom Adapter verwendeten Daten.  
+Alle Daten werden in unveränderter Form, so wie sie von der Datenschnittstelle geliefert werden, vom Adapter bereitgestellt.
+
+Wird ein aktivierter History-Adapter (_history_, _influxdb_ oder _sql_) für einen Werte-State erkannt, dann werden gegebenenfalls in der Historie fehlende Datenpunkte durch den Adapter automatisch nachgetragen, sodass sich vollständige Zeitreihen ergeben.
+
+Die aktuellen Messdaten werden von dem Adapter standardmäßig im Stundentakt aktualisiert. Ein geringerer Aktualisierungsintervall ist meist nicht sinnvoll, da die zu Grunde liegenden Messdaten auf dem BfS-Server (abhängig von der Messstelle) größtenteils stündlich aktualisiert werden.  
+Beim ersten Start des Adapters wird automatisch der Zeitpunkt für den Abruf der Daten angepasst, sodass nicht alle Installation die Daten zur gleichen Zeit abrufen und die Datenschnittstelle des BfS nicht unnötig belastet wird.
+
+[![Screenshot 1](../ioBroker-odl-01.png)](../ioBroker-odl-01.png)
+
+[![Screenshot 2](../ioBroker-odl-02.png)](../ioBroker-odl-02.png)

docs/en/README.md

@@ -0,0 +1,26 @@
+# ioBroker.odl
+
+![Logo](../../admin/odl.png)
+
+## The current environmental radioactivity in ioBroker
+
+This adapter integrates the ODL (Ortsdosisleistung / Ambient Dose Rate) values of specified measuring points of the German [Federal Office for Radiation Protection (Bundesamt für Strahlenschutz, BfS)](https://www.bfs.de/) into ioBroker.
+
+The ODL measuring network of the Federal Office for Radiation Protection uses around 1,700 measuring probes to monitor radiation levels from natural radioactivity in the environment around the clock. The measuring network has an important early warning function in order to quickly detect increased radiation from radioactive substances in the air in Germany.  
+The measurement data obtained are collected and evaluated by the BfS and made publicly available under the _Data License Germany_.
+
+For more details regarding the Ambient Dose Rate see <https://odlinfo.bfs.de/>.
+
+This adapter downloads the current 1 hour mean values of the measurement data using the [official data interface provided by the BfS](https://odlinfo.bfs.de/ODL/EN/service/data-interface/data-interface_node.html). The BfS
+
+Dieser Adapter läd die aktuellen 1-Stunden-Mittelwerte der Messdaten direkt über die [offizielle Datenschnittstelle des BfS](https://odlinfo.bfs.de/ODL/DE/service/datenschnittstelle/datenschnittstelle_node.html). The BfS is the originator of the data used by the adapter.  
+All data is provided by the adapter in an unchanged form as delivered by the data interface.
+
+If an enabled history adapter (_history_, _influxdb_ or _sql_) is detected for some value state, the adapter tries to fill missing values in the history by downloading missing values to create a complete history.
+
+By default, the adapter updates the current measurement data every hour. A shorter update interval is usually not useful, since the underlying measurement data on the BfS server (depending on the measuring point) are mostly updated hourly.  
+When the adapter is started for the first time, the time for retrieving the data is automatically adjusted so that not all installations retrieve the data at the same time and the BfS data interface is not unnecessarily loaded.
+
+[![Screenshot 1](../ioBroker-odl-01.png)](../ioBroker-odl-01.png)
+
+[![Screenshot 2](../ioBroker-odl-02.png)](../ioBroker-odl-02.png)

io-package.json

@@ -121,6 +121,10 @@
       "zh-cn": "来自德国联邦辐射防护局的环境剂量率数据。",
       "uk": "Дані про потужність дози навколишнього середовища від Федерального відомства радіаційного захисту Німеччини."
     },
+    "docs": {
+      "en": "docs/en/README.md",
+      "de": "docs/de/README.md"
+    },
     "authors": [
       "Peter Müller <[email protected]>"
     ],