Skip to content

Commit bcd2b89

Browse files
authored
Update README for 4.0 release (#418)
1 parent 431013a commit bcd2b89

File tree

9 files changed

+10
-560
lines changed

9 files changed

+10
-560
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Swift Crypto is an open-source implementation of a substantial portion of the AP
77
Swift Crypto is available as a Swift Package Manager package. To use it, add the following dependency in your `Package.swift`:
88

99
```swift
10-
// swift-crypto 1.x, 2.x and 3.x are almost API compatible, so most clients
10+
// swift-crypto 1.x, 2.x, 3.x, and 4.x are almost API compatible, so most clients
1111
// should allow any of them
12-
.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "4.0.0"),
12+
.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "5.0.0"),
1313
```
1414

1515
and to your target, add `Crypto` to your dependencies. You can then `import Crypto` to get access to Swift Crypto's functionality.
@@ -108,7 +108,7 @@ If you believe you have identified a vulnerability in Swift Crypto, please [repo
108108

109109
### Swift versions
110110

111-
The most recent versions of Swift Crypto support Swift 5.7 and newer. The minimum Swift version supported by Swift Crypto releases are detailed below:
111+
The most recent versions of Swift Crypto support Swift 6 and newer. The minimum Swift version supported by Swift Crypto releases are detailed below:
112112

113113
Swift Crypto | Minimum Swift Version
114114
--------------------|----------------------
@@ -119,7 +119,8 @@ Swift Crypto | Minimum Swift Version
119119
`3.1.0 ..< 3.3.0` | 5.7
120120
`3.3.0 ..< 3.8.0` | 5.8
121121
`3.9.0 ..< 3.13.0` | 5.9
122-
`3.13.0 ...` | 5.10
122+
`3.13.0 ..< 4.0.0` | 5.10
123+
`4.0.0 ...` | 6.0
123124

124125
### Compatibility
125126

@@ -131,10 +132,14 @@ SemVer and Swift Crypto's Public API guarantees should result in a working progr
131132

132133
Swift Crypto 2.0.0 was released in September 2021. The only breaking change between Swift Crypto 2.0.0 and 1.0.0 was the addition of new cases in the `CryptoError` enumeration. For most users, then, it's safe to depend on either the 1.0.0 _or_ 2.0.0 series of releases.
133134

135+
Swift Crypto 3.0.0 was released in September 2023. Again the only breaking change was the addition of new cases in the `CryptoError` enumeration, so most users can safely depend on the 1.0.0, 2.0.0, or 3.0.0 series of releases.
136+
137+
Swift Crypto 4.0.0 was released in September 2025. Again the only breaking change was the addition of new cases in the `CryptoError` enumeration, so most users can safely depend on the 1.0.0, 2.0.0, 3.0.0, or 4.0.0 series of releases. Note that in this release `_CryptoExtras` was renamed to `CryptoExtras`. The old products and targets have been kept around for compatibility reasons, but users depending only on new code should use `CryptoExtras` not `_CryptoExtras`.
138+
134139
To do so, please use the following dependency in your `Package.swift`:
135140

136141
```swift
137-
.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "3.0.0"),
142+
.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "5.0.0"),
138143
```
139144

140145
### Developing Swift Crypto on macOS

Sources/_CryptoExtras/EC/ObjectIdentifier.swift

Lines changed: 0 additions & 37 deletions
This file was deleted.

Sources/_CryptoExtras/EC/PKCS8DERRepresentation.swift

Lines changed: 0 additions & 76 deletions
This file was deleted.

Sources/_CryptoExtras/EC/PKCS8PrivateKey.swift

Lines changed: 0 additions & 93 deletions
This file was deleted.

Sources/_CryptoExtras/EC/RFC8410AlgorithmIdentifier.swift

Lines changed: 0 additions & 74 deletions
This file was deleted.

Sources/_CryptoExtras/Util/ThreadSpecific/ThreadOps.swift

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)