From 701d752f2512acf4e27f1d6d3f771b5bdf0f82cb Mon Sep 17 00:00:00 2001 From: Honza Dvorsky Date: Thu, 16 Nov 2023 08:47:28 +0100 Subject: [PATCH] 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. --- Package.swift | 2 +- README.md | 12 ++++++++---- .../Documentation.docc/Documentation.md | 8 ++++---- 3 files changed, 13 insertions(+), 9 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..30e5981 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # AsyncHTTPClient Transport for Swift OpenAPI Generator -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. +[![](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://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). ## 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..a70975d 100644 --- a/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md +++ b/Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md @@ -4,14 +4,14 @@ 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). ### Supported platforms and minimum versions -| macOS | Linux | -| :-: | :-: | -| ✅ 10.15+ | ✅ | +| macOS | Linux | iOS | tvOS | watchOS | +| :-: | :-: | :-: | :-: | :-: | +| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ### Usage