From e9c8803bf52ad412fab816d40a5b6b849c924b79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=CC=8Cimon=20S=CC=8Cesta=CC=81k?= Date: Tue, 13 Jan 2026 16:30:45 +0100 Subject: [PATCH] docs: Update README with requirements and limitations - Add Requirements section (iOS 16+, macOS 13+, Swift 5.9+) - Add Limitations section header - Note network observers availability for logging/analytics - Update usage example URL formatting Co-Authored-By: Claude Opus 4.5 --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9118907..c7467f9 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,21 @@ Lightweight GraphQL API client based on [Apollo iOS](https://github.com/apollographql/apollo-ios). Developed to simplify [Futured](https://www.futured.app) in-house development of applications, that work with GraphQL APIs. +## Requirements + +- iOS 16.0+ / macOS 13.0+ +- Swift 5.9+ +- Apollo iOS 1.17.0 + +## Limitations + Currently there is no support for some Apollo's features: - Apollo built-in cache - GraphQL subscriptions - Custom interceptors +Network observers are available for logging and analytics. + ## Installation Install or add following line to your dependencies: @@ -110,7 +120,9 @@ let mutation = MyExampleMutation() import GraphQLAPIKit import GraphQLGenerated -let apiAdapter = GraphQLAPIAdapter(url: URL(string: "https://MyAPIUrl.com")!) +let apiAdapter = GraphQLAPIAdapter( + url: URL(string: "https://api.example.com/graphql")! +) let queryResult = await apiAdapter.fetch(query: query) let mutationResult = await apiAdapter.perform(mutation: mutation) ```