swift-server/swift-openapi-async-http-client
1
0
Fork 0
mirror of https://github.com/swift-server/swift-openapi-async-http-client.git synced 2026-06-02 07:47:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add README badges (#24)

Browse Source 
### 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.
This commit is contained in:
Honza Dvorsky
2023-11-16 08:47:28 +01:00
committed by GitHub
parent e48b152d18
commit 701d752f25
3 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/OpenAPIAsyncHTTPClient/Documentation.docc/Documentation.md
+4 -4
View File
@@ -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