chore: discord link update

gql-dart · Nov 12, 2023 · a112874 · a112874
1 parent f6a6419
commit a112874
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 18 deletions.
diff --git a/packages/ferry/README.md b/packages/ferry/README.md
@@ -6,40 +6,67 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
+
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
+
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 A simple, powerful GraphQL Client for Flutter and Dart.
 
 # [Documentation](https://ferrygraphql.com/) 📖
 
 # Features
 
-1. ✅ **Fully Typed**: work faster and safer with compile time checks and IDE autocomplete, including fully typed Cache reads and writes.
-2. 🔄 **Built-In Code Generators**: automatically generated immutable data classes for all your GraphQL Operations and Fragments, based on your schema.
-3. 🌐 **Customizable Network Interface**: highly customizable network interface using `gql_link`, allowing you to compose and extend `Link`s.
-4. ✨ **Normalized Optimistic Cache**: keep data in sync with cache normalization and update your UI instantly with optimistic data.
-5. 💾 **Multiple Data Stores**: extensible `Store` interface with built-in `MemoryStore` and `HiveStore` (which uses `hive` for offline persistence).
-6. 📄 **Refetch & Pagination**: easily update responses with new data or combine multiple responses, allowing for seamless pagination.
-7. 📱 **Flutter Widgets**: Widgets for Queries, Mutations, and Subscriptions, available out of the box.
+1. ✅ **Fully Typed**: work faster and safer with compile time checks and IDE autocomplete, including
+   fully typed Cache reads and writes.
+2. 🔄 **Built-In Code Generators**: automatically generated immutable data classes for all your
+   GraphQL Operations and Fragments, based on your schema.
+3. 🌐 **Customizable Network Interface**: highly customizable network interface using `gql_link`,
+   allowing you to compose and extend `Link`s.
+4. ✨ **Normalized Optimistic Cache**: keep data in sync with cache normalization and update your UI
+   instantly with optimistic data.
+5. 💾 **Multiple Data Stores**: extensible `Store` interface with built-in `MemoryStore`
+   and `HiveStore` (which uses `hive` for offline persistence).
+6. 📄 **Refetch & Pagination**: easily update responses with new data or combine multiple responses,
+   allowing for seamless pagination.
+7. 📱 **Flutter Widgets**: Widgets for Queries, Mutations, and Subscriptions, available out of the
+   box.
 8. 🧈 **Smooth**: Run queries in a separate Isolate to free up resources on the UI thread
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=flat-square
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
+
 [prs-link]: http://makeapullrequest.com
+
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=flat-square&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=flat-square&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [pub-badge]: https://img.shields.io/pub/v/ferry?logo=dart
+
 [pub-link]: https://pub.dev/packages/ferry
diff --git a/packages/ferry_flutter/README.md b/packages/ferry_flutter/README.md
@@ -6,20 +6,30 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
 
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
 
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 Flutter widgets for executing GraphQL operations using the `ferry` client.
 
-NOTE: you may not need these widgets to work with `ferry` in Flutter. They are actually just thin wrappers around Flutter's `StreamBuilder` widget.
+NOTE: you may not need these widgets to work with `ferry` in Flutter. They are actually just thin
+wrappers around Flutter's `StreamBuilder` widget.
diff --git a/packages/ferry_generator/README.md b/packages/ferry_generator/README.md
@@ -6,18 +6,27 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
 
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
 
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 A Dart code generator to create fully typed `OperationRequest`s to be used with the `ferry` client.
diff --git a/packages/ferry_hive_store/README.md b/packages/ferry_hive_store/README.md
@@ -6,18 +6,27 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
 
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
 
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 A Store implementation that uses `hive` to persist data.
diff --git a/packages/ferry_store/README.md b/packages/ferry_store/README.md
@@ -6,18 +6,27 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
 
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
 
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 The base `Store` class used in `ferry`'s Cache, along with the default `MemoryStore` implementation.
diff --git a/packages/normalize/README.md b/packages/normalize/README.md
@@ -6,23 +6,35 @@
 [![Discord][discord-badge]][discord-link]
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/ferry.svg?style=for-the-badge
+
 [license-link]: https://github.com/gql-dart/ferry/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+
 [prs-link]: https://github.com/gql-dart/ferry/issues
 
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/ferry/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/ferry/stargazers
+
 [github-forks-badge]: https://img.shields.io/github/forks/gql-dart/ferry.svg?style=for-the-badge&logo=github&logoColor=ffffff
+
 [github-forks-link]: https://github.com/gql-dart/ferry/network/members
 
 [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff
-[discord-link]: https://discord.gg/QRTfXE
+
+[discord-link]: https://discord.gg/YBFCTXNbwY
 
 Normalizes and denormalizes data for GraphQL operations.
 
-The `normalize` function writes normalized documents to a normalized `Map` and can be used to cache results of GraphQL queries. It traverses the [GraphQL AST](https://github.com/gql-dart/gql/blob/master/gql/README.md) and only includes the fields specified in the GraphQL Document in the normalized results.
+The `normalize` function writes normalized documents to a normalized `Map` and can be used to cache
+results of GraphQL queries. It traverses
+the [GraphQL AST](https://github.com/gql-dart/gql/blob/master/gql/README.md) and only includes the
+fields specified in the GraphQL Document in the normalized results.
 
 The `normalize` function only normalizes entities that include a `__typename` field and a valid ID.
 
@@ -42,7 +54,7 @@ The library includes the following methods:
 ## Features
 
 | Feature                                                                                                                           | Progress |
-| :-------------------------------------------------------------------------------------------------------------------------------- | :------: |
+|:----------------------------------------------------------------------------------------------------------------------------------|:--------:|
 | Fragments                                                                                                                         |    ✅     |
 | Variables                                                                                                                         |    ✅     |
 | Interface & Union types                                                                                                           |    ✅     |
@@ -162,7 +174,9 @@ Which will produce the following normalized result:
 }
 ```
 
-If we later want to denormalize this data (for example, when reading from a cache), we can call `denormalize` on the normalizedMap from above. This will give us back the original data response object.
+If we later want to denormalize this data (for example, when reading from a cache), we can
+call `denormalize` on the normalizedMap from above. This will give us back the original data
+response object.
 
 ```dart
 denormalizeOperation(
@@ -173,17 +187,26 @@ denormalizeOperation(
 
 ## Limitations
 
-`TypePolicy.keyFields` and `FieldPolicy.keyArgs` currently only accept a flat list of `String`s. Functions and nested lists of strings and are not yet supported. `FieldPolicy.merge` and `FieldPolicy.read` are also not yet supported.
+`TypePolicy.keyFields` and `FieldPolicy.keyArgs` currently only accept a flat list of `String`s.
+Functions and nested lists of strings and are not yet supported. `FieldPolicy.merge`
+and `FieldPolicy.read` are also not yet supported.
 
 ## Dependencies
 
 This library depends on the [gql](https://github.com/gql-dart/gql) library.
 
 [license-badge]: https://img.shields.io/github/license/gql-dart/normalize.svg?style=flat-square
+
 [license-link]: https://github.com/gql-dart/normalize/blob/master/LICENSE
+
 [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
+
 [prs-link]: http://makeapullrequest.com
+
 [github-watch-badge]: https://img.shields.io/github/watchers/gql-dart/normalize.svg?style=flat-square&logo=github&logoColor=ffffff
+
 [github-watch-link]: https://github.com/gql-dart/normalize/watchers
+
 [github-star-badge]: https://img.shields.io/github/stars/gql-dart/normalize.svg?style=flat-square&logo=github&logoColor=ffffff
+
 [github-star-link]: https://github.com/gql-dart/normalize/stargazers