From eaae2e33fdf621ddcbf5a706abcd6c8da20c21dd Mon Sep 17 00:00:00 2001 From: Guillaume Chau Date: Sun, 28 Nov 2021 22:45:13 +0100 Subject: [PATCH] docs: update READMEs --- README.md | 24 +++++++++++---------- packages/vue-apollo-components/README.md | 19 +++++++---------- packages/vue-apollo-composable/README.md | 19 +++++++---------- packages/vue-apollo-option/README.md | 19 +++++++---------- packages/vue-apollo-ssr/README.md | 19 +++++++---------- packages/vue-apollo-util/README.md | 27 ++++++++++++++++++++++-- 6 files changed, 70 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 6655e48..6baca3e 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,25 @@ [![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4)

- -
- - Become a Patreon - -
+

-
-Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) -
+[:pen: Contributing guide](./CONTRIBUTING.md) -[Contributing guide](./CONTRIBUTING.md) +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) -
+In this monorepository: + +| Package | Description | +|---------|-------------| +|[@vue/apollo-composable](./packages/vue-apollo-composable) |Composition API| +|[@vue/apollo-option](./packages/vue-apollo-option) |Options API| +|[@vue/apollo-components](./packages/vue-apollo-components) |Components with slots| +|[@vue/apollo-ssr](./packages/vue-apollo-ssr) |Server-Side Rendering Utils| +|[@vue/apollo-util](./packages/vue-apollo-util) |Other Utils| ## Sponsors diff --git a/packages/vue-apollo-components/README.md b/packages/vue-apollo-components/README.md index 246127f..198c98b 100644 --- a/packages/vue-apollo-components/README.md +++ b/packages/vue-apollo-components/README.md @@ -6,23 +6,20 @@ [![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4)

- -
- - Become a Patreon - -
+

-
-Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) -
+[:pen: Contributing guide](./CONTRIBUTING.md) -[Contributing guide](../CONTRIBUTING.md) +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) -
+```bash +npm i @vue/apollo-components +yarn add @vue/apollo-components +``` ## Sponsors diff --git a/packages/vue-apollo-composable/README.md b/packages/vue-apollo-composable/README.md index 55cb0d4..24c985d 100644 --- a/packages/vue-apollo-composable/README.md +++ b/packages/vue-apollo-composable/README.md @@ -6,23 +6,20 @@ [![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4)

- -
- - Become a Patreon - -
+

-
-Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) -
+[:pen: Contributing guide](./CONTRIBUTING.md) -[Contributing guide](../CONTRIBUTING.md) +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) -
+```bash +npm i @vue/apollo-composable +yarn add @vue/apollo-composable +``` ## Sponsors diff --git a/packages/vue-apollo-option/README.md b/packages/vue-apollo-option/README.md index d3158cc..806825e 100644 --- a/packages/vue-apollo-option/README.md +++ b/packages/vue-apollo-option/README.md @@ -6,23 +6,20 @@ [![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4)

- -
- - Become a Patreon - -
+

-
-Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) -
+[:pen: Contributing guide](./CONTRIBUTING.md) -[Contributing guide](../CONTRIBUTING.md) +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) -
+```bash +npm i @vue/apollo-option +yarn add @vue/apollo-option +``` ## Sponsors diff --git a/packages/vue-apollo-ssr/README.md b/packages/vue-apollo-ssr/README.md index 49edbdc..721aecd 100644 --- a/packages/vue-apollo-ssr/README.md +++ b/packages/vue-apollo-ssr/README.md @@ -6,23 +6,20 @@ [![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4)

- -
- - Become a Patreon - -
+

-
-Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) -
+[:pen: Contributing guide](./CONTRIBUTING.md) -[Contributing guide](../CONTRIBUTING.md) +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) -
+```bash +npm i @vue/apollo-ssr +yarn add @vue/apollo-ssr +``` ## Sponsors diff --git a/packages/vue-apollo-util/README.md b/packages/vue-apollo-util/README.md index 97eb1d5..11a6929 100644 --- a/packages/vue-apollo-util/README.md +++ b/packages/vue-apollo-util/README.md @@ -1,3 +1,26 @@ -# @vue/apollo-util +# Utilities for Vue Apollo -Utilities for Vue Apollo +[![npm](https://img.shields.io/npm/v/@vue/apollo-util.svg) ![npm](https://img.shields.io/npm/dm/@vue/apollo-util.svg)](https://www.npmjs.com/package/@vue/apollo-util) +[![apollo3](https://img.shields.io/badge/apollo-3.x-blue.svg)](https://www.apollographql.com/) +[![vue3](https://img.shields.io/badge/vue-3-brightgreen.svg)](https://vuejs.org/) +[![CircleCI branch](https://img.shields.io/circleci/build/github/vuejs/vue-apollo/v4.svg)](https://circleci.com/gh/vuejs/vue-apollo/tree/v4) + +

+ +

+ + +:book: Documentation [**for Vue 3**](http://v4.apollo.vuejs.org) | [for Vue 2](https://apollo.vuejs.org/) + +[:pen: Contributing guide](./CONTRIBUTING.md) + +[:heart: Sponsor me!](https://github.com/sponsors/Akryum) + +```bash +npm i @vue/apollo-util +yarn add @vue/apollo-util +``` + +## Sponsors + +[![sponsors logos](https://guillaume-chau.info/sponsors.png)](https://guillaume-chau.info/sponsors)