add deprecation notice

derf · May 27, 2024 · 221acdf · 221acdf
1 parent c127ccf
commit 221acdf
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,18 @@ homepage](https://finalrewind.org/projects/Travel-Status-DE-IRIS/) for details.
 It provides both human- and machine-readable access to departure data at german
 train stations via text and JSON output.
 
+## DEPRECATION NOTICE
+
+As of may 2024, the backend service that this utility relies on is deprecated
+and may cease operation in the near future. There is no immediate successor.
+Hence, db-iris and Travel::Status::DE::IRIS are no longer actively maintained.
+There is no promise that issues and merge requests will be reviewed or merged.
+
+The **hafas-m** application that is part of [Travel::Status::DE::HAFAS](https://finalrewind.org/projects/Travel-Status-DE-DeutscheBahn/)
+provides similar features. However, its default "DB" backend is also
+deprecated. There is no migration path to a Deutsche Bahn departure monitor
+that is not deprecated at the moment.
+
 ## Installation
 
 You have five installation options:

diff --git a/bin/db-iris b/bin/db-iris
@@ -589,6 +589,18 @@ B<db-iris> [B<-rx>] [B<-d> I<date>] [B<-o> I<output-flags>]
 
 version 1.96
 
+=head1 DEPRECATION NOTICE
+
+As of may 2024, the backend service that this utility relies on is deprecated
+and may cease operation in the near future. There is no immediate successor.
+Hence, db-iris and Travel::Status::DE::IRIS are no longer actively maintained.
+There is no promise that issues and merge requests will be reviewed or merged.
+
+The B<hafas-m> application that is part of Travel::Status::DE::HAFAS(3pm)
+provides similar features. However, its default "DB" backend is also
+deprecated. There is no migration path to a Deutsche Bahn departure monitor
+that is not deprecated at the moment.
+
 =head1 DESCRIPTION
 
 db-iris is an interface to the DeutscheBahn departure monitor

diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm
@@ -998,6 +998,17 @@ Non-blocking variant (EXPERIMENTAL):
 
 version 1.96
 
+=head1 DEPRECATION NOTICE
+
+As of may 2024, the backend service that this module relies on is deprecated
+and may cease operation in the near future. There is no immediate successor.
+Hence, Travel::Status::DE::IRIS is no longer actively maintained.  There is no
+promise that issues and merge requests will be reviewed or merged.
+
+The Travel::Status::DE::HAFAS(3pm) module provides similar features. However,
+its default "DB" backend is also deprecated. There is no migration path to a
+Deutsche Bahn departure monitor that is not deprecated at the moment.
+
 =head1 DESCRIPTION
 
 Travel::Status::DE::IRIS is an unofficial interface to IRIS based web