DC-6716 Add deprecation flag and updated README file (#36)

* DC-6716 Add deprecation flag and updated README file

* DC-6716 Remove commented lines on build.sbt and libDependencies and to use EmailAddress class in README file

* DC-6716 Update LibDependecies and README file

README.md

@@ -1,4 +1,9 @@
-#emailaddress
+## emailaddress
+
+This library is Deprecated.
+You can reach out Digital-Contact team for further assistance.<br>
+Alternatively you can write you own EmailAddress class as in the following example: https://github.com/hmrc/preferences-frontend/blob/main/app/emailaddress/EmailAddress.scala
+
 
 [![Join the chat at https://gitter.im/hmrc/emailaddress](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hmrc/emailaddress?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/hmrc/emailaddress.svg?branch=master)](https://travis-ci.org/hmrc/emailaddress) [ ![Download](https://api.bintray.com/packages/hmrc/releases/emailaddress/images/download.svg) ](https://bintray.com/hmrc/releases/emailaddress/_latestVersion)
 

build.sbt

@@ -21,21 +21,10 @@ lazy val commonSettings =
 lazy val emailaddress = Project(appName, file("."))
   .settings(publish / skip := true)
   .aggregate(
-    play28,
     play29,
     play30
   )
 
-lazy val play28 = Project(s"$appName-play-28", file("play-28"))
-  .settings(
-    crossScalaVersions := Seq(scala2_12, scala2_13),
-    libraryDependencies ++= LibDependencies.compileDependencies(PlayVersion.Play28) +: LibDependencies.testDependencies,
-    libraryDependencySchemes += "org.scala-lang.modules" %% "scala-xml" % VersionScheme.Always,
-    sharedSources
-  )
-  .settings(commonSettings)
-
-
 lazy val play29 = Project(s"$appName-play-29", file("play-29"))
   .settings(
     crossScalaVersions := Seq(scala2_13),

project/LibDependencies.scala

@@ -15,7 +15,6 @@ object LibDependencies {
   }
 
   def compileDependencies(playVersion: PlayVersion) = playVersion match {
-    case PlayVersion.Play28 => "com.typesafe.play" %% "play" % "2.8.21"
     case PlayVersion.Play29 => "com.typesafe.play" %% "play" % "2.9.0"
     case PlayVersion.Play30 => "org.playframework" %% "play" % "3.0.0"
   }

repository.yaml

@@ -1,2 +1,3 @@
 repoVisibility: public_0C3F0CE3E6E6448FAD341E7BFA50FCD333E06A20CFF05FCACE61154DDBBADF71
 description: Micro-library for validating and obfuscating email addresses
+deprecated: true