dnrops
/
swift-nio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor fixes in docs (#928) 

Motivation:

Some things weren't 100% clear or wrong, let's fix em.

Modifications:

fixed 'em.

Result:

better docs
This commit is contained in:
Johannes Weiss 2019-03-26 11:26:10 +00:00 committed by GitHub
parent b8368b6e09
commit 09bace11d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -7,9 +7,9 @@ It's like [Netty](https://netty.io), but written for Swift.
### Repository organization
The SwiftNIO project is split across multiple repositories
The SwiftNIO project is split across multiple repositories:
Repository | Swift 5 | Swift 4
Repository | NIO 2 (Swift 5) | NIO 1 (Swift 4+)
--- | --- | ---
[https://github.com/apple/swift-nio][repo-nio] <br> SwiftNIO core | `from: "2.0.0"` | `from: "1.0.0"`
[https://github.com/apple/swift-nio-ssl][repo-nio-ssl] <br> TLS (SSL) support | `from: "2.0.0"` | `from: "1.0.0"`
@ -32,7 +32,7 @@ The latest released SwiftNIO 1 version supports Swift 4.0, 4.1, 4.2, and 5.0.
#### SwiftNIO 2
The latest released SwiftNIO 2 version supports Swift 5.0. If you have a SwiftNIO 1 application or library that you would like to migrate to SwiftNIO 2, please check out the [migration guide](docs/migration-guide-NIO1-to-NIO2.md) we prepared for you.
The latest released SwiftNIO 2 version supports only Swift 5.0. If you have a SwiftNIO 1 application or library that you would like to migrate to SwiftNIO 2, please check out the [migration guide](docs/migration-guide-NIO1-to-NIO2.md) we prepared for you.
### Compatibility

2
docs/migration-guide-NIO1-to-NIO2.md
View File

@ -16,7 +16,7 @@ Update the NIO packages you use to include the following versions.
- `swift-nio`: `.package(url: "https://github.com/apple/swift-nio.git", from: "2.0.0")`
- `swift-nio-ssl`: `.package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.0.0")`
- `swift-nio-extras`: `.package(url: "https://github.com/apple/swift-nio.git", from: "1.0.0")`
- `swift-nio-extras`: `.package(url: "https://github.com/apple/swift-nio-extras.git", from: "1.0.0")`
- `swift-nio-http2`: `.package(url: "https://github.com/apple/swift-nio-http2.git", from: "1.0.0")`
- `swift-nio-transport-services`: `.package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.0.0")`