Skip to content

Commit 70b63ef

Browse files
authored
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.
1 parent 22ec9a6 commit 70b63ef

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# URLSession Transport for Swift OpenAPI Generator
22

3+
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-openapi-urlsession/documentation)
4+
[![](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)
5+
[![](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)
6+
37
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.
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
812
| macOS | Linux | iOS | tvOS | watchOS |
913
| :-: | :-: | :-: | :-: | :-: |
10-
| ✅ 10.15+ | | ✅ 13+ | ✅ 13+ | ✅ 6+ |
14+
| ✅ 10.15+ || ✅ 13+ | ✅ 13+ | ✅ 6+ |
1115

1216
## Usage
1317

0 commit comments

Comments
 (0)