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

Jump to bottom

Update Readme to recommend using Xcode package support #59

Merged
merged 3 commits into from
Oct 11, 2019
Merged

Update Readme to recommend using Xcode package support #59

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
921434f
Include updated wording about including NIO Transport Services in a p…
tkrajacic Oct 11, 2019
41d5f7f
Add clause about usage in Xcode 10
tkrajacic Oct 11, 2019
b7a16d1
Update README.md
tkrajacic Oct 11, 2019
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
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,33 @@ Network.framework is Apple's reference implementation of the [proposed post-sock

## How to Use?

Today, the easiest way to use SwiftNIO Transport Services in an iOS project is through CocoaPods:
NIO Transport Services primarily uses SwiftPM as its build tool, so we recommend using that as well. If you want to depend on NIO Transport Services in your own project, it's as simple as adding a dependencies clause to your Package.swift:

```
dependencies: [
.package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.1.1")
]
```

and then adding the NIOTransportServices module to your target dependencies.

If your project is set up as an Xcode project and you're using Xcode 11+, you can add NIO Transport Services as a dependency to your Xcode project by clicking File -> Swift Packages -> Add Package Dependency. In the upcoming dialog, please enter `https://github.com/apple/swift-nio-transport-services.git` and click Next twice. Finally, make sure `NIOTransportServices` is selected and click finish. Now will be able to `import NIOTransportServices` in your project.

You can also use SwiftNIO Transport Services in an iOS project through CocoaPods:

pod 'SwiftNIO', '~> 2.0.0'
pod 'SwiftNIOTransportServices', '~> 1.0.0'

You can also use the Swift Package Manager:
If you want to develop SwiftNIO with Xcode 10, you have to generate an Xcode project:

```
swift build
swift package generate-xcodeproj
```

and add the project as a sub-project by dragging it into your iOS project and adding the frameworks (such as `NIO.framework`) in 'Build Phases' -> 'Link Binary Libraries'.
and add the project as a sub-project by dragging it into your iOS project and adding the framework (`NIOTransportServices.framework`) in 'Build Phases' -> 'Link Binary Libraries'.

Do note however that Network.framework requires macOS 10.14+, iOS 12+, or tvOS 12+.


## 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
Expand Down