Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 701d752

Browse files
Add README badges (#24)
### Motivation Surface the Swift version and platform support status from Swift Package Index. ### Modifications Added badges, plus a quick link to the docc docs, to the top of the README. Also, expanded the supported platforms, we do actually support iOS and friends (was an oversight not to include it before). ### Result Easier to quickly see our support matrix, plus the quick link to docs. ### Test Plan Previewed locally.
1 parent e48b152 commit 701d752

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

‎Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ swiftSettings.append(
2929
let package = Package(
3030
name: "swift-openapi-async-http-client",
3131
platforms: [
32-
.macOS(.v10_15),
32+
.macOS(.v10_15),.iOS(.v13),.tvOS(.v13),.watchOS(.v6),
3333
],
3434
products: [
3535
.library(

‎README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# AsyncHTTPClient Transport for Swift OpenAPI Generator
22

3-
A client transport that uses the [HTTPClient](https://swift-server.github.io/async-http-client/docs/current/AsyncHTTPClient/Classes/HTTPClient) type from the [AsyncHTTPClient](https://github.com/swift-server/async-http-client) library to perform HTTP operations.
3+
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client/documentation)
4+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fswift-server%2Fswift-openapi-async-http-client%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client)
5+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fswift-server%2Fswift-openapi-async-http-client%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client)
6+
7+
A client transport that uses the [HTTPClient](https://swiftpackageindex.com/swift-server/async-http-client/documentation/asynchttpclient/httpclient) type from the [AsyncHTTPClient](https://github.com/swift-server/async-http-client) library to perform HTTP operations.
48

59
Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator).
610

711
## Supported platforms and minimum versions
8-
| macOS | Linux |
9-
| :-: | :-: |
10-
| ✅ 10.15+ | ✅ |
12+
| macOS | Linux| iOS | tvOS | watchOS |
13+
| :-: | :-: | :-: | :-: | :-: |
14+
| ✅ 10.15+ | ✅| ✅ 13+ | ✅ 13+ | ✅ 6+ |
1115

1216
## Usage
1317

‎Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Send HTTP requests to the server using the AsyncHTTPClient library.
44

55
## Overview
66

7-
A client transport that uses the [HTTPClient](https://swift-server.github.io/async-http-client/docs/current/AsyncHTTPClient/Classes/HTTPClient) type from the [AsyncHTTPClient](https://github.com/swift-server/async-http-client) library to perform HTTP operations.
7+
A client transport that uses the [HTTPClient](https://swiftpackageindex.com/swift-server/async-http-client/documentation/asynchttpclient/httpclient) type from the [AsyncHTTPClient](https://github.com/swift-server/async-http-client) library to perform HTTP operations.
88

99
Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator).
1010

1111
### Supported platforms and minimum versions
12-
| macOS | Linux |
13-
| :-: | :-: |
14-
| ✅ 10.15+ | ✅ |
12+
| macOS | Linux | iOS | tvOS | watchOS |
13+
| :-: | :-: | :-: | :-: | :-: |
14+
| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ |
1515

1616
### Usage
1717

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /