|
1 |
| -# README |
| 1 | +<p align="center"> |
| 2 | + <img src="https://user-images.githubusercontent.com/146856/124335690-fc7ecd80-db4f-11eb-93fa-dcf4469bb07b.png" alt="Apollo GraphQL"/> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <a href="https://github.com/apollographql/apollo-ios-dev/actions/workflows/ci-tests.yml"> |
| 7 | + <img src="https://github.com/apollographql/apollo-ios-dev/actions/workflows/ci-tests.yml/badge.svg?branch=main" alt="GitHub Action Status"> |
| 8 | + </a> |
| 9 | + <a href="https://raw.githubusercontent.com/apollographql/apollo-ios-pagination/main/LICENSE"> |
| 10 | + <img src="https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000" alt="MIT license"> |
| 11 | + </a> |
| 12 | + <a href="Platforms"> |
| 13 | + <img src="https://img.shields.io/badge/platforms-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS-333333.svg" alt="Supported Platforms: iOS, macOS, tvOS, watchOS" /> |
| 14 | + </a> |
| 15 | +</p> |
| 16 | + |
| 17 | +<p align="center"> |
| 18 | + <a href="https://github.com/apple/swift"> |
| 19 | + <img src="https://img.shields.io/badge/Swift-5.7-orange.svg" alt="Swift 5.7 supported"> |
| 20 | + </a> |
| 21 | + <a href="https://swift.org/package-manager/"> |
| 22 | + <img src="https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square" alt="Swift Package Manager compatible"> |
| 23 | + </a> |
| 24 | +</p> |
2 | 25 |
|
3 | 26 | > [!IMPORTANT]
|
4 |
| -> This library is currently pre-release and in active development. The API is subject to breaking changes until the first stable release. |
| 27 | +> This library is currently released as a 0.x version and is in active development. The API is subject to breaking changes until the stable 1.0 release. |
| 28 | +
|
| 29 | +| ☑️ Apollo Clients User Survey | |
| 30 | +| :----- | |
| 31 | +| What do you like best about Apollo iOS? What needs to be improved? Please tell us by taking a [one-minute survey](https://docs.google.com/forms/d/e/1FAIpQLSczNDXfJne3ZUOXjk9Ursm9JYvhTh1_nFTDfdq3XBAFWCzplQ/viewform?usp=pp_url&entry.1170701325=Apollo+iOS&entry.204965213=Readme). Your responses will help us understand Apollo iOS usage and allow us to serve you better. | |
| 32 | + |
| 33 | +### Apollo iOS Pagination |
| 34 | + |
| 35 | +This repo provides an API way to handle paginated queries for Apollo iOS. |
| 36 | + |
| 37 | +`ApolloPagination` uses an `ApolloClient` to fetch and cache your paginated query data. It supports: |
| 38 | + |
| 39 | +- Reading/Writing paginated data with an Apollo `NormalizedCache` |
| 40 | +- Watching paginated data for changes |
| 41 | +- Forward, Reverse, and Bi-directional pagination |
| 42 | +- Cursor-based, offset-based, and custom pagination mechanisms |
| 43 | + |
| 44 | +## Issues |
| 45 | + |
| 46 | +To report an issue, bug, or feature request you can do so in the [apollo-ios](https://github.com/apollographql/apollo-ios/issues) repo. |
| 47 | + |
| 48 | +## Roadmap |
| 49 | + |
| 50 | +The [roadmap](https://github.com/apollographql/apollo-ios/blob/main/ROADMAP.md) is a high-level document that describes the next major steps or milestones for this project. We are always open to feature requests, and contributions from the community. |
| 51 | + |
| 52 | +## Contributing |
| 53 | + |
| 54 | +If you'd like to contribute, please refer to the [Apollo Contributor Guide](https://github.com/apollographql/apollo-ios-dev/blob/main/CONTRIBUTING.md). |
| 55 | + |
| 56 | +## Maintainers |
| 57 | + |
| 58 | +- [@AnthonyMDev](https://github.com/AnthonyMDev) |
| 59 | +- [@calvincestari](https://github.com/calvincestari) |
| 60 | +- [@bignimbus](https://github.com/bignimbus) |
| 61 | +- [@bobafetters](https://github.com/bobafetters) |
| 62 | +- [@Iron-Ham](https://github.com/Iron-Ham) |
| 63 | + |
| 64 | +## Who is Apollo? |
| 65 | + |
| 66 | +[Apollo](https://apollographql.com/) builds open-source software and a graph platform to unify GraphQL across your apps and services. We help you ship faster with: |
| 67 | + |
| 68 | +- [Apollo Studio](https://www.apollographql.com/studio/develop/) – A free, end-to-end platform for managing your GraphQL lifecycle. Track your GraphQL schemas in a hosted registry to create a source of truth for everything in your graph. Studio provides an IDE (Apollo Explorer) so you can explore data, collaborate on queries, observe usage, and safely make schema changes. |
| 69 | +- [Apollo Federation](https://www.apollographql.com/apollo-federation) – The industry-standard open architecture for building a distributed graph. Use Apollo’s gateway to compose a unified graph from multiple subgraphs, determine a query plan, and route requests across your services. |
| 70 | +- [Apollo Client](https://www.apollographql.com/apollo-client/) – The most popular GraphQL client for the web. Apollo also builds and maintains [Apollo iOS](https://github.com/apollographql/apollo-ios) and [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin). |
| 71 | +- [Apollo Server](https://www.apollographql.com/docs/apollo-server/) – A production-ready JavaScript GraphQL server that connects to any microservice, API, or database. Compatible with all popular JavaScript frameworks and deployable in serverless environments. |
5 | 72 |
|
6 |
| -## `ApolloPagination` is a simple pagination library for iOS that works with Apollo GraphQL queries |
| 73 | +## Learn how to build with Apollo |
7 | 74 |
|
8 |
| -`ApolloPagination` allows you to easily watch paginated queries. |
| 75 | +Check out the [Odyssey](https://odyssey.apollographql.com/) learning platform, the perfect place to start your GraphQL journey with videos and interactive code challenges. Join the [Apollo Community](https://community.apollographql.com/) to interact with and get technical help from the GraphQL community. |
0 commit comments