From 70b63efd9c53207e9f7d93e262513a21ee285046 Mon Sep 17 00:00:00 2001 From: Honza Dvorsky Date: Thu, 16 Nov 2023 09:39:55 +0100 Subject: [PATCH] Add README badges (#23) ### 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. ### Result Easier to quickly see our support matrix, plus the quick link to docs. ### Test Plan Previewed locally. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f46fae..2b0ae2d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # URLSession Transport for Swift OpenAPI Generator +[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-openapi-urlsession/documentation) +[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-openapi-urlsession%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/apple/swift-openapi-urlsession) +[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-openapi-urlsession%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/apple/swift-openapi-urlsession) + A client transport that uses the [URLSession](https://developer.apple.com/documentation/foundation/urlsession) type from the [Foundation](https://developer.apple.com/documentation/foundation) framework to perform HTTP operations. Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator). @@ -7,7 +11,7 @@ Use the transport with client code generated by [Swift OpenAPI Generator](https: ## Supported platforms and minimum versions | macOS | Linux | iOS | tvOS | watchOS | | :-: | :-: | :-: | :-: | :-: | - | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | + | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ## Usage