Merge pull request #51 from gumob:release/v3.0.0

Release/v3.0.0
gumob · Aug 24, 2024 · fb5ce11 · fb5ce11
2 parents f08b7a9 + 985777c
commit fb5ce11
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 4 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -302,42 +302,52 @@ jobs:
       matrix:
         include:
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "macos"
             configuration: "Release"
             name: "Pods: macOS, Release"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "macos"
             configuration: "Debug"
             name: "Pods: macOS, Debug"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "ios"
             configuration: "Release"
             name: "Pods: iOS, Release"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "ios"
             configuration: "Debug"
             name: "Pods: iOS, Debug"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "tvos"
             configuration: "Release"
             name: "Pods: tvOS, Release"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "tvos"
             configuration: "Debug"
             name: "Pods: tvOS, Debug"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "watchos"
             configuration: "Release"
             name: "Pods: watchOS, Release"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "watchos"
             configuration: "Debug"
             name: "Pods: watchOS, Debug"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "visionos"
             configuration: "Release"
             name: "Pods: visionOS, Release"
           - xcode: "Xcode_15.4"
+            runsOn: macOS-14
             platform: "visionos"
             configuration: "Debug"
             name: "Pods: visionOS, Debug"

diff --git a/README.md b/README.md
@@ -16,11 +16,29 @@
 
 Punycode is a representation of Unicode with the limited ASCII character subset used for Internet host names. Using Punycode, host names containing Unicode characters are transcoded to a subset of ASCII consisting of letters, digits, and hyphen, which is called the Letter-Digit-Hyphen (LDH) subset. For example, München (German name for Munich) is encoded as Mnchen-3ya. [(Wikipedia)](https://en.wikipedia.org/wiki/Punycode)
 
-## Requirements
+## Changes in 3.0.0
 
-- iOS 12.0 or later
+### Breaking Changes
+❗The framework name has been changed from ~~**`Punycode`**~~ to **`PunycodeSwift`**.
+This change is based on the information provided in [this issue](https://github.com/swiftlang/swift/issues/56573), which discusses potential naming conflicts in Swift modules.
+
+\* There are no changes to the framework's API, and it remains fully compatible with versions 2.x.x.
+
+### Other Changes
+- Updated macOS version from 10.12 to 10.13.
+- Updated iOS version from 9.3 to 12.0.
+- Updated tvOS version from 10.2 to 12.0.
+- Added support for watchOS 4.0 or later.
+- Added support for visionOS 1.0 or later.
+- Swift version updated from 4.2 to 5.0.
+
+
+## Requirements
 - macOS 10.13 or later
+- iOS 12.0 or later
 - tvOS 12.0 or later
+- watchOS 4.0 or later
+- visionOS 1.0 or later
 - Swift 5.0 or later
 
 <!--<small>* No plans to support tvOS 11 or earlier for now</small>-->
@@ -33,6 +51,7 @@ Add the following to your `Cartfile` and follow [these instructions](https://git
 
 ```Certfile
 github "gumob/PunycodeSwift"          # Latest (Swift 5.0)
+github "gumob/PunycodeSwift" ~> 3.0   # Swift 5.0
 github "gumob/PunycodeSwift" ~> 2.2   # Swift 5.0
 github "gumob/PunycodeSwift" ~> 1.0   # Swift 4.2
 ```
@@ -46,6 +65,7 @@ platform :ios, '12.0'
 use_frameworks!
 
 pod 'Punycode'             # Latest (Swift 5.0)
+pod 'Punycode', '~> 3.0'   # Swift 5.0
 pod 'Punycode', '~> 2.2'   # Swift 5.0
 pod 'Punycode', '~> 1.0'   # Swift 4.2
 ```
@@ -55,7 +75,7 @@ pod 'Punycode', '~> 1.0'   # Swift 4.2
 Encode and decode IDNA:
 
 ```swift
-import Punycode
+import PunycodeSwift
 
 var sushi: String = "寿司"
 
@@ -69,7 +89,7 @@ print(sushi)  // "寿司"
 Encode and decode Punycode directly:
 
 ```swift
-import Punycode
+import PunycodeSwift
 
 var sushi: String = "寿司"