From 4e7086a2d3a250e09e408791373f511ee1f636d9 Mon Sep 17 00:00:00 2001 From: Honza Dvorsky Date: Wed, 8 Nov 2023 14:41:23 +0100 Subject: [PATCH 1/2] Add README badges --- Package.swift | 2 +- README.md | 10 +++++++--- .../Documentation.docc/Documentation.md | 6 +++--- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/Package.swift b/Package.swift index 2c1c322..b6af358 100644 --- a/Package.swift +++ b/Package.swift @@ -29,7 +29,7 @@ swiftSettings.append( let package = Package( name: "swift-openapi-async-http-client", platforms: [ - .macOS(.v10_15), + .macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6), ], products: [ .library( diff --git a/README.md b/README.md index 666c32b..a3561b4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # AsyncHTTPClient Transport for Swift OpenAPI Generator +[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client/documentation) +[![](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) +[![](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) + 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. Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator). ## Supported platforms and minimum versions - | macOS | Linux | - | :-: | :-: | - | ✅ 10.15+ | ✅ | +| macOS | Linux | iOS | tvOS | watchOS | +| :-: | :-: | :-: | :-: | :-: | +| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ## Usage diff --git a/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md b/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md index 25d9032..cb7182f 100644 --- a/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md +++ b/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md @@ -9,9 +9,9 @@ A client transport that uses the [HTTPClient](https://swift-server.github.io/asy Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator). ### Supported platforms and minimum versions -| macOS | Linux | -| :-: | :-: | -| ✅ 10.15+ | ✅ | +| macOS | Linux | iOS | tvOS | watchOS | +| :-: | :-: | :-: | :-: | :-: | +| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ### Usage From 373f36a7c5bbd1f82e7e087a6a97bf20dddf1bbf Mon Sep 17 00:00:00 2001 From: Honza Dvorsky Date: Wed, 8 Nov 2023 14:51:50 +0100 Subject: [PATCH 2/2] PR feedback --- README.md | 2 +- .../OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a3561b4..30e5981 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![](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) [![](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) -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. +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. Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator). diff --git a/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md b/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md index cb7182f..a70975d 100644 --- a/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md +++ b/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md @@ -4,7 +4,7 @@ Send HTTP requests to the server using the AsyncHTTPClient library. ## Overview -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. +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. Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator).