Skip to content

Commit 28918a2

Browse files
bignimbusBoDmartinbonnin
authored
New README info architecture and content (#6561)
* New README info architecture and content * Update README.md Co-authored-by: Benoit 'BoD' Lubek <[email protected]> * Update README.md Co-authored-by: Martin Bonnin <[email protected]> * Update README.md Co-authored-by: Martin Bonnin <[email protected]> * Update README.md Co-authored-by: Martin Bonnin <[email protected]> * Update README.md * Update README.md (code review) * Update README.md - correct links --------- Co-authored-by: Benoit 'BoD' Lubek <[email protected]> Co-authored-by: Martin Bonnin <[email protected]>
1 parent d50a884 commit 28918a2

File tree

1 file changed

+78
-29
lines changed

1 file changed

+78
-29
lines changed

‎README.md

Lines changed: 78 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<div align="center">
2-
3-
<p>
4-
<a href="https://www.apollographql.com/"><img src="https://raw.githubusercontent.com/apollographql/apollo-client-devtools/a7147d7db5e29b28224821bf238ba8e3a2fdf904/assets/apollo-wordmark.svg" height="100" alt="Apollo Client"></a>
5-
</p>
1+
<header>
2+
<div align="center">
3+
<a href="https://www.apollographql.com?utm_medium=github&utm_source=apollographql_apollo-kotlin&utm_campaign=readme"><img src="https://raw.githubusercontent.com/apollographql/apollo-client-devtools/main/assets/apollo-wordmark.svg" height="100" alt="Apollo Logo"></a>
4+
</div>
5+
<div align="center">
66

77
[![Discourse](https://img.shields.io/discourse/topics?label=Discourse&server=https%3A%2F%2Fcommunity.apollographql.com&logo=discourse&color=467B95&style=flat-square)](http://community.apollographql.com/new-topic?category=Help&tags=mobile,client)
88
[![Slack](https://img.shields.io/static/v1?label=kotlinlang&message=apollo-kotlin&color=A97BFF&logo=slack&style=flat-square)](https://app.slack.com/client/T09229ZC6/C01A6KM1SBZ)
@@ -14,44 +14,93 @@
1414

1515
[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A&style=flat-square)](https://ge.apollographql.com/scans)
1616

17-
</div>
17+
</div>
18+
<h1 align="center">Apollo Kotlin</h1>
19+
20+
**The industry-leading GraphQL client for Kotlin**. Run on Android and all the Kotlin multiplatform targets. Apollo Kotlin delivers powerful caching, code generation, intuitive APIs, and comprehensive developer tools to accelerate your app development.
21+
</header>
1822

1923

20-
| ☑️ Apollo Clients User Survey |
21-
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22-
| What do you like best about Apollo Kotlin? 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+Kotlin&entry.204965213=Readme). Your responses will help us understand Apollo Kotlin usage and allow us to serve you better. |
24+
## ❓ Why Choose Apollo Kotlin?
25+
26+
✅ 100% type safety, from your server to your app, using code generation.
27+
✅ Intuitive, powerful caching - intelligent in-memory or SQLite caching out of the box<br>
28+
✅ Excellent support for modern Android and Kotlin Multiplatform apps<br>
29+
✅ Always up-to-date - we prioritize support for the latest versions of GraphQL, Kotlin, Gradle, and more<br>
30+
✅ GraphOS ready - turnkey support for Persisted Queries, and `@defer`<br>
31+
✅ Production-tested - Powers countless apps worldwide that serve millions of end users<br>
32+
33+
## 🚀 Quick Start
34+
35+
If you are new to GraphQL, check out [the tutorial](https://www.apollographql.com/tutorials/apollo-kotlin-android-part1) that will guide you through building an Android app using Apollo.
36+
37+
For more in-depth documentation, head to the [official documentation site](https://www.apollographql.com/docs/kotlin?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme).
38+
39+
For a detailed "Get Started" guide, check out our [docs](https://www.apollographql.com/docs/kotlin?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme).
40+
41+
## 💡 Resources
42+
43+
| Resource | Description | Link |
44+
| ----- | ----- | ----- |
45+
| **Full Documentation** | Comprehensive guides and examples | [Read Docs →](https://www.apollographql.com/docs/kotlin?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) |
46+
| **API Reference** | Complete API documentation | [Browse Kdoc →](https://apollographql.github.io/apollo-kotlin/kdoc/older/4.2.0/index.html?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) |
47+
| **IntelliJ Plugin** | Enhanced development experience | [Install Plugin →](https://plugins.jetbrains.com/plugin/20645-apollo-graphql) |
48+
| **Free Course** | Learn GraphQL and Apollo Client | [Take Course →](https://www.apollographql.com/tutorials/apollo-kotlin-android-part1?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) |
2349

24-
## 🚀 Apollo Kotlin
50+
## 🧑‍🚀 About Apollo
2551

26-
Apollo Kotlin is a strongly typed GraphQL client that generates Kotlin models for your GraphQL operations.
52+
Deliver tomorrow's roadmap today with our comprehensive suite of API orchestration tools:
2753

28-
Apollo Kotlin executes operations against a GraphQL server and returns results as operation-specific Kotlin types. This means you don't have to deal with parsing JSON, or passing around `Map`s and making clients cast values to the right type manually. You also don't have to write model types yourself, because these are generated from the GraphQL definitions your app uses.
54+
* [**Apollo Client**](https://www.apollographql.com/docs/react?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) \- Type-safe apps with GraphQL-powered on-device caching ([React](https://www.apollographql.com/docs/react?utm_medium=github&utm_source=apollographql_apollo-kotlin&utm_campaign=readme), [iOS](https://www.apollographql.com/docs/ios?utm_medium=github&utm_source=apollographql_apollo-kotlin&utm_campaign=readme), [Kotlin](https://www.apollographql.com/docs/kotlin?utm_medium=github&utm_source=apollographql_apollo-kotlin&utm_campaign=readme))
55+
* [**Apollo Connectors**](https://www.apollographql.com/graphos/apollo-connectors?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) \- Compose all your GraphQL and REST APIs into one GraphQL endpoint
56+
* [**Apollo MCP Server**](https://www.apollographql.com/apollo-mcp-server?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) \- AI needs APIs. The fastest way to ship reliable AI experiences
57+
* [**Apollo Router**](https://www.apollographql.com/docs/router?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) \- Scale your APIs seamlessly with GraphQL Federation, Security, Auth, and more
58+
* [**GraphOS**](https://www.apollographql.com/graphos?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme) \- Deploy, manage, govern, and explore your APIs ([start for free, no credit card needed](https://www.apollographql.com/pricing?utm_medium=github&utm_source=apollographql_apollo-kotlin&utm_campaign=readme))
59+
60+
[**Explore the Complete Apollo Platform →**](https://www.apollographql.com/?utm_source=github&utm_medium=apollographql-_apollo-kotlin&utm_campaign=readme)
61+
62+
## 🛠️ Maintained by
63+
64+
|Name|Username|
65+
|---|---|
66+
|Benoit Lubek|[@bod](https://github.com/bod)|
67+
|Jeff Auriemma|[@bignimbus](https://github.com/bignimbus)|
68+
|Martin Bonnin|[@martinbonnin](https://github.com/martinbonnin)|
69+
70+
## 🗺️ Roadmap
71+
72+
We regularly update our [public roadmap](https://github.com/apollographql/apollo-kotlin/blob/main/ROADMAP.md) with the status of our work-in-progress and upcoming features.
73+
74+
## 📣 Tell us what you think
75+
76+
| ☑️ Apollo Kotlin User Survey |
77+
| :----- |
78+
| What do you like best about Apollo Kotlin? 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+Kotlin&entry.204965213=Readme). Your responses will help us understand Apollo Kotlin usage and allow us to serve you better. |
2979

30-
Because generated types are operation-specific and validated against the schema, you can only access data that you actually specify as part of an operation. If you don't ask for a particular field in an operation, you can't access the corresponding property on the returned data structure.
80+
## 🗓️ Events
3181

32-
This library is designed with Android in mind, but you can use it in any Kotlin application, including KMP ([Kotlin Multi Platform](https://kotlinlang.org/docs/multiplatform.html)).
82+
Join these live events to meet other GraphQL users and learn more:
3383

34-
Apollo Kotlin aims to comply with the [Working Draft of the GraphQL specification](https://spec.graphql.org/draft/).
84+
🎪 [**GraphQL Summit 2025**](https://summit.graphql.com?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme)
85+
Oct 6-8, 2025 • San Francisco
86+
*1000+ engineers, talks, workshops, and office hours*
3587

36-
## 📚 Documentation
88+
🌟 [**GraphQLConf 2025**](https://graphql.org/conf/2025)
89+
Sep 8-10, 2025 • Amsterdam
90+
*Celebrating 10 Years of GraphQL*
3791

38-
All Apollo Kotlin documentation, including caching and helpful recipes, can be found at: <br/>
39-
[https://www.apollographql.com/docs/kotlin/](https://www.apollographql.com/docs/kotlin/)
92+
[**View All Events →**](https://www.apollographql.com/events?utm_source=github&utm_medium=apollographql_apollo-kotlin&utm_campaign=readme)
4093

41-
The Apollo Kotlin API reference can be found at: <br/>
42-
[https://apollographql.github.io/apollo-kotlin/kdoc/](https://apollographql.github.io/apollo-kotlin/kdoc/)
94+
## 🏆 Contributing
4395

44-
Tutorials can be found in the Odyssey learning platform: [part1](https://www.apollographql.com/tutorials/apollo-kotlin-android-part1), [part2](https://www.apollographql.com/tutorials/apollo-kotlin-android-part2).
96+
Thank you for your interest in submitting a Pull Request to Apollo Kotlin! Read our [guidelines](https://github.com/apollographql/apollo-kotlin/blob/main/CONTRIBUTING.md) first, and don't hesitate to get in touch.
4597

46-
## 👨‍💻 Who is Apollo?
98+
**New to open source?** Check out our [**Good First Issues**](https://github.com/apollographql/apollo-kotlin/issues?q=is%3Aopen%20label%3A%22%3Abooks%3A%20good-first-issue%22) to get started.
4799

48-
[Apollo](https://apollographql.com/) builds open-source tools and commercial services to make application development easier, better, and accessible to more people. We help you ship faster with:
100+
## 🤝 Code of Conduct
49101

50-
* [GraphOS](https://www.apollographql.com/graphos) - The platform for building, managing, and scaling a supergraph: a unified network of your organization's microservices and their data sources—all composed into a single distributed API.
51-
* [Apollo Federation](https://www.apollographql.com/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.
52-
* [Apollo Client](https://github.com/apollographql/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).
53-
* [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.
102+
Please read our [Code of Conduct](https://community.apollographql.com/faq). This applies to any space run by Apollo, including our GitHub repositories, the Apollo GraphOS Discord, the Apollo GraphQL Forum. The Code of Conduct reflects our commitment to making the Apollo Community a welcoming and safe space in which individuals can interact.
54103

55-
## 🎓 Learn how to build with Apollo
104+
## 🪪 License
56105

57-
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.
106+
Source code in this repository is available under the terms of the MIT License. Read the full text [here](https://github.com/apollographql/apollo-kotlin/blob/main/LICENSE).

0 commit comments

Comments
 (0)