Skip to content

Update readme documentation #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ssestak merged 1 commit into from
Jan 13, 2026
Merged

Update readme documentation #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
```
Expand Down