Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/v3.0.0 #53

Merged
merged 2 commits into from
Aug 24, 2024
Merged

Release/v3.0.0 #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf06a5f
chore: Remove FIXME comment
gumob Aug 24, 2024
cc5d035
docs(README.md): Revert framework name and update requirements and in…
gumob Aug 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,6 @@

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)

## Changes in 3.0.0

### 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
Expand All @@ -45,6 +28,16 @@ This change is based on the information provided in [this issue](https://github.

## Installation

### Swift Package Manager

Add the following to your `Package.swift` file.

```swift
dependencies: [
.package(url: "https://github.com/gumob/PunycodeSwift.git", .upToNextMajor(from: "3.0.0"))
]
```

### Carthage

Add the following to your `Cartfile` and follow [these instructions](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).
Expand All @@ -61,9 +54,6 @@ github "gumob/PunycodeSwift" ~> 1.0 # Swift 4.2
To integrate Punycode into your project, add the following to your `Podfile`.

```ruby
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
Expand All @@ -75,7 +65,7 @@ pod 'Punycode', '~> 1.0' # Swift 4.2
Encode and decode IDNA:

```swift
import PunycodeSwift
import Punycode

var sushi: String = "寿司"

Expand All @@ -89,7 +79,7 @@ print(sushi) // "寿司"
Encode and decode Punycode directly:

```swift
import PunycodeSwift
import Punycode

var sushi: String = "寿司"

Expand Down
5 changes: 0 additions & 5 deletions Source/Punycode.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@

import Foundation

/// FIXME: public class 'Punycode.Punycode' shadows module 'Punycode', which may cause failures
/// when importing 'Punycode' or its clients in some configurations; please rename either
/// the class 'Punycode.Punycode' or the module 'Punycode', or see
/// https://github.com/apple/swift/issues/56573 for workarounds

public class Puny {

/// Punycode RFC 3492
Expand Down