mirror
/
swift-nio-transport-services
mirror of https://github.com/apple/swift-nio-transport-services.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add supported platforms to README (#87) 

Motivation:

We have a weird availability model for NIOTS since we can build it even
if Network.framework isn't available: we don't document this anywhere.

Modifications:

Explain supported platform model in the README.

Result:

Better documentation.
This commit is contained in:
George Barnett 2020-05-15 13:49:35 +01:00 committed by GitHub
parent 4eb9bebfb8
commit aac0780fef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -43,6 +43,19 @@ and add the project as a sub-project by dragging it into your iOS project and ad
Do note however that Network.framework requires macOS 10.14+, iOS 12+, or tvOS 12+.
### Supported Platforms
NIOTransportServices is supported where Network.framework is supported: macOS
10.14+, iOS 12+, tvOS 12+, and watchOS 6+.
In order to allow dependencies to use NIOTransportServices when it's available
and fallback to NIO when it isn't, all code is behind import guards checking
the availability of Network.framework. As such NIOTransportServices may be
built on platforms where Network.framework is *not* available.
NIOTransportServices can be built on macOS 10.12+, iOS 10+, tvOS 10+, watchOS
6+ and Linux but is only functionally useful on macOS 10.14+, iOS 12+, tvOS 12+
and watchOS 6+.
## Versioning
Just like the rest of the SwiftNIO family, `swift-nio-transport-services` follows [SemVer 2.0.0](https://semver.org/#semantic-versioning-200) with a separate document