[ALLI-11319] Add section to the README file with the deprecation noti…

…ce. Add @deprecated annotations to the main interfaces.
AgencyPMG · Feb 26, 2024 · 0d714df · 0d714df
1 parent afd5942
commit 0d714df
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,13 @@
 
 [![Build Status](https://travis-ci.org/AgencyPMG/CsvSugar.svg)](https://travis-ci.org/AgencyPMG/CsvSugar)
 
+:warning: **DEPRECATION NOTICE**: This project is no longer maintained and might not work as expected.
+Use [Alli Platform SDK for PHP](https://github.com/AgencyPMG/alli-platform-sdk-php/tree/master/src/Fixtures) instead.
+Check this migration guide for more information:
+[Migrating from PMG CsvSugar to Alli Platform SDK for PHP](https://agencypmg.atlassian.net/wiki/spaces/ALLISDK/pages/2996862986/Alli+Platform+SDK+0.36+Upgrade+Guide)
+
+***
+
 A few helpers to make reading and writing CSV (and other delimited files)
 a bit easier.
 

diff --git a/src/Reader.php b/src/Reader.php
@@ -19,6 +19,8 @@
  * }
  *
  * @since 1.0
+ *
+ * @deprecated This class is deprecated. Use [Alli\Platform\Util\Csv\Reader](https://github.com/AgencyPMG/alli-platform-sdk-php/blob/master/src/Util/Csv/Reader.php) instead.
  */
 interface Reader extends \Traversable
 {

diff --git a/src/Writer.php b/src/Writer.php
@@ -15,6 +15,8 @@
  * Common interface for CSV writers.
  *
  * @since 1.0
+ *
+ * @deprecated This class is deprecated. Use [Alli\Platform\Util\Csv\Writer](https://github.com/AgencyPMG/alli-platform-sdk-php/blob/master/src/Util/Csv/Writer.php) instead.
  */
 interface Writer
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,6 +19,8 @@ @@
      * }
      *
      * @since 1.0
+     *
+     * @deprecated This class is deprecated. Use [Alli\Platform\Util\Csv\Reader](https://github.com/AgencyPMG/alli-platform-sdk-php/blob/master/src/Util/Csv/Reader.php) instead.
      */
     interface Reader extends \Traversable
     {
@@ Expand Down @@