Merge pull request #33 from bahmanm/prepare-v5.0.0

Prepare v5.0
bahmanm · Oct 7, 2023 · 8e0b343 · 8e0b343
2 parents ec11625 + f3d8800
commit 8e0b343
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 30 deletions.
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -0,0 +1,2 @@
+version = "3.7.10"
+runner.dialect = scala213
diff --git a/README.md b/README.md
@@ -6,67 +6,57 @@ A collection of utilities for Scala/Java developers who are targeting Persian (F
 
 ### 1.1  Scala Compatibility ###
 
-| ↓persianutils │ scala→ | 2.10.x | 2.11.x | 2.12.x | 2.13.x |
-|------------------------|--------|--------|--------|--------|
-| 2.x                    |    X   |    X   |    -   |    -   |
-| 3.x                    |    -   |    X   |    X   |    -   |
-| 4.x                    |    -   |    X   |    X   |    X   |
-
+| ⬇ persianutils ❚ scala ➡ | 2.10.x | 2.11.x | 2.12.x | 2.13.x | 3.x  |
+|----------------------------|--------|--------|--------|--------|------|
+| 5.x                        |   ❌   |   ❌   |  ✅   |   ✅   |  ✅  |
+| 4.x                        |   ❌   |   ✅   |  ✅   |   ✅   |  ❌  |
+| 3.x                        |   ❌   |   ✅   |  ✅   |   ❌   |  ❌  |
+| 2.x                        |   ✅   |   ✅   |  ❌   |   ❌   |  ❌  |
 
 ## 2 Adding To Your Project ##
 
 ### 2.1 SBT ###
 
 ```scala
 libraryDependencies ++= Seq(
-    "com.bahmanm" %% "persianutils" % "4.0" // or 2.0
+    "com.bahmanm" %% "persianutils" % "5.0.0"
 )
 ```
 
 ### 2.2 Maven ###
 
-With Scala 2.13.x:
+With Scala 3.x:
 
 ```xml
 <dependencies>
     <dependency>
         <groupId>com.bahmanm</groupId>
-        <artifactId>persianutils_2.13</artifactId>
-        <version>4.0</version>
+        <artifactId>persianutils_3</artifactId>
+        <version>5.0</version>
     </dependency>
 </dependencies>
 ```
 
-With Scala 2.12.x:
+With Scala 2.13.x:
 
 ```xml
 <dependencies>
     <dependency>
         <groupId>com.bahmanm</groupId>
-        <artifactId>persianutils_2.12</artifactId>
-        <version>4.0</version>
+        <artifactId>persianutils_2.13</artifactId>
+        <version>5.0</version>
     </dependency>
 </dependencies>
 ```
 
-With Scala 2.11.x:
-```xml
-<dependencies>
-    <dependency>
-        <groupId>com.bahmanm</groupId>
-        <artifactId>persianutils_2.11</artifactId>
-        <version>4.0</version>
-    </dependency>
-</dependencies>
-```
+With Scala 2.12.x:
 
-With Scala 2.10.x:
 ```xml
 <dependencies>
     <dependency>
         <groupId>com.bahmanm</groupId>
-        <artifactId>persianutils_2.10</artifactId>
-        <version>2.0</version>
+        <artifactId>persianutils_2.12</artifactId>
+        <version>5.0</version>
     </dependency>
 </dependencies>
 ```
@@ -81,9 +71,6 @@ This is a short review of what you will find in _persianutils_:
 
 #### 3.1.1 Scala ####
 
-_NOTE: persianutils 3.x works with Scala 2.11.x and 2.12.x series. If you need to work with
-Scala 2.10.x, please use persianutils 2.0._
-
 ```scala
 import com.bahmanm.persianutils.DateConverter._
 
@@ -138,4 +125,6 @@ assert(NumToWord(299792458) == "دویست و نود و نه میلیون و ه
 ```
 
 ## 4 Contributors ##
+
 * [Amir Karimi](https://github.com/AmirKarimi)
+* [Keivan Abdi](https://github.com/KeivanAbdi)
diff --git a/build.sbt b/build.sbt
@@ -3,7 +3,7 @@
 ////////////////////////////////////////////////////////////////////////////////
 name := "persianutils"
 description := "A collection of utilities for Scala/Java developers who are targeting Persian (Farsi) speaking users."
-version := "5.0-SNAPSHOT"
+version := "5.0"
 homepage := Some(url("https://github.com/bahmanm/persianutils"))
 licenses += "Apache 2" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt")
 organization := "com.bahmanm"