Skip to content

Commit 540001c

Browse files
committed
Updating readme for release
1 parent 5b9e42d commit 540001c

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@
66

77
SyntaxSparrow is a Swift library designed to facilitate the analysis and interaction with Swift source code. It leverages SwiftSyntax to parse Swift code and produce a syntax tree which collects and traverses constituent declaration types for Swift code.
88

9-
# Note on Sift 5.7 Support
10-
The latest version of the underlying [swift-syntax](https://github.com/swiftlang/swift-syntax) library no longer supports swift 5.7, as such, Syntax Sparrow will stop active support for Swift 5.7 from version 5.0.0
11-
12-
If you need support for 5.7, and specifically want features added after the 5.0.0 bump, you may need to fork the repo and add support yourself. If there is a backwards compatible change that can be captured as a minor update we will gladly release it via the PR process. However, if there are changes resulting in a major bump with 5.7 support, we would like to look at an alternate release process for that version (or let you maintain it on your own fork).
13-
149
## Workflows:
1510

1611
| Branch | Latest Swift/Xcode |
@@ -31,6 +26,15 @@ If you need support for 5.7, and specifically want features added after the 5.0.
3126
- [License](#license)
3227
- [Contributing](#contributing)
3328

29+
## Swift 6 Support
30+
SyntaxSparrow added explicit support for Swift 6 (and the Swift 6 language mode) as of version `5.0.0`. It is still compatible back to Swift 5.8, however, the package manifests for version 5.8, 5.9, and 5.10 do not include the explicit swift 6 language mode setting.
31+
32+
## Note on Swift 5.7 Support
33+
34+
The latest version of the underlying [swift-syntax](https://github.com/swiftlang/swift-syntax) library no longer supports swift 5.7, as such, Syntax Sparrow will stop active support for Swift 5.7 from version 5.0.0
35+
36+
If you need support for 5.7, and specifically want features added after the 5.0.0 bump, you may need to fork the repo and add support yourself. If there is a backwards compatible change that can be captured as a minor update we will gladly release it via the PR process. However, if there are changes resulting in a major bump with 5.7 support, we would like to look at an alternate release process for that version (or let you maintain it on your own fork).
37+
3438
## About the Project
3539
SyntaxSparrow was built on heavy inspiration from the now archived [SwiftSemantics](https://github.com/SwiftDocOrg/SwiftSemantics) project. `SwiftSemantics` was awesome, but being archived the only option is to fork and add features yourself, or hope someone has added your feature to their fork. `SyntaxSparrow` aims to pick up where this left off and add more support for conveniences, features, and harden parsing where needed.
3640

@@ -341,7 +345,7 @@ Currently, SyntaxSparrow supports Swift Package Manager (SPM).
341345
To add SyntaxSparrow to your project, add the following line to your dependencies in your Package.swift file:
342346

343347
```swift
344-
.package(url: "https://github.com/CheekyGhost-Labs/SyntaxSparrow", from: "4.3.0")
348+
.package(url: "https://github.com/CheekyGhost-Labs/SyntaxSparrow", from: "5.0.0")
345349
```
346350

347351
Then, add SyntaxSparrow as a dependency for your target:

0 commit comments

Comments
 (0)