Skip to content

Commit 2a70073

Browse files
docs: update the package readme
Signed-off-by: Vincenzo Palazzo <[email protected]>
1 parent 057eb44 commit 2a70073

File tree

2 files changed

+55
-21
lines changed

2 files changed

+55
-21
lines changed

packages/graphql/README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,35 @@
1-
[![MIT License][license-badge]][license-link]
2-
[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors)
3-
[![PRs Welcome][prs-badge]][prs-link]
1+
<div align="center">
2+
<h1>GraphQL <Client></Client></h1>
43

5-
[![Star on GitHub][github-star-badge]][github-star-link]
6-
[![Watch on GitHub][github-watch-badge]][github-watch-link]
7-
[![Discord][discord-badge]][discord-link]
4+
<div align="center">
5+
<img src="https://miro.medium.com/max/1400/1*bU9k3XzmNAQ9F9J0uCiFsQ.png" width="800"/>
6+
</div>
87

9-
[![Build Status][build-status-badge]][build-status-link]
10-
[![Coverage][coverage-badge]][coverage-link]
11-
[![version][version-badge]][package-link]
8+
<p>
9+
<strong>Client implementation to interact with any graphql server</strong>
10+
</p>
1211

13-
# GraphQL Client
12+
<h4>
13+
<a href="https://github.com/zino-hofmann/graphql-flutter">Project Homepage</a>
14+
</h4>
1415

15-
[`graphql/client.dart`](https://pub.dev/packages/graphql) is a GraphQL client for dart modeled on the [apollo client], and is currently the most popular GraphQL client for dart. It is co-developed alongside [`graphql_flutter`](https://pub.dev/packages/graphql_flutter) [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community alongside the rest of the GraphQL Dart community on [discord][discord-link].
16+
<a href="https://github.com/laanwj/rust-clightning-rpc/actions">
17+
<img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/laanwj/rust-clightning-rpc/Integration%20testing/master?style=flat-square"/>
18+
</a>
19+
20+
<a href="https://pub.dev/packages/graphql">
21+
<img alt="Pub Popularity" src="https://img.shields.io/pub/popularity/graphql?style=flat-square"/>
22+
</a>
23+
24+
<a href="https://discord.gg/YBFCTXNbwY">
25+
<img alt="Discord" src="https://img.shields.io/discord/559455668810153989?style=flat-square"/>
26+
</a>
27+
28+
</div>
29+
30+
## Introduction
31+
32+
[graphql/client.dart](https://pub.dev/packages/graphql) is a GraphQL client for dart modeled on the [apollo client], and is currently the most popular GraphQL client for dart. It is co-developed alongside [`graphql_flutter`](https://pub.dev/packages/graphql_flutter) [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community alongside the rest of the GraphQL Dart community on [discord][discord-link].
1633

1734
As of `v4`, it is built on foundational libraries from the [gql-dart project], including [`gql`], [`gql_link`], and [`normalize`]. We also depend on [hive](https://docs.hivedb.dev/#/) for persistence via `HiveStore`.
1835

packages/graphql_flutter/README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
1-
[![MIT License][license-badge]][license-link]
2-
[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors)
3-
[![PRs Welcome][prs-badge]][prs-link]
1+
<div align="center">
2+
<h1>GraphQL Flutter</h1>
43

5-
[![Star on GitHub][github-star-badge]][github-star-link]
6-
[![Watch on GitHub][github-watch-badge]][github-watch-link]
7-
[![Discord][discord-badge]][discord-link]
4+
<div align="center">
5+
<img src="https://miro.medium.com/max/1400/1*bU9k3XzmNAQ9F9J0uCiFsQ.png" width="800"/>
6+
</div>
87

9-
[![Build Status][build-status-badge]][build-status-link]
10-
[![Coverage][coverage-badge]][coverage-link]
11-
[![version][version-badge]][package-link]
8+
<p>
9+
<strong>Flutter Widgets wrapper around graphql API</strong>
10+
</p>
1211

13-
# GraphQL Flutter
12+
<h4>
13+
<a href="https://github.com/zino-hofmann/graphql-flutter">Project Homepage</a>
14+
</h4>
15+
16+
<a href="https://github.com/laanwj/rust-clightning-rpc/actions">
17+
<img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/laanwj/rust-clightning-rpc/Integration%20testing/master?style=flat-square"/>
18+
</a>
19+
20+
<a href="https://pub.dev/packages/graphql">
21+
<img alt="Pub Popularity" src="https://img.shields.io/pub/popularity/graphql?style=flat-square"/>
22+
</a>
23+
24+
<a href="https://discord.gg/YBFCTXNbwY">
25+
<img alt="Discord" src="https://img.shields.io/discord/559455668810153989?style=flat-square"/>
26+
</a>
27+
28+
</div>
29+
30+
## Introduction
1431

1532
`graphql_flutter` provides an idiomatic flutter API and widgets for [`graphql/client.dart`](https://pub.dev/packages/graphql). They are co-developed [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community on [discord][discord-link].
1633

0 commit comments

Comments
 (0)