Skip to content

Commit 3ad3cd3

Browse files
committed
Docs
1 parent 4a094af commit 3ad3cd3

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/guide/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Introduction
22

3-
This [Vuex-ORM](https://github.com/vuex-orm/vuex-orm) plugin uses the
4-
[apollo-client](https://www.apollographql.com/client/) to let you sync your Vuex-ORM database with your server via
5-
a [GraphQL API](http://graphql.org/).
3+
Vuex-ORM-GraphQL is a plugin for the amazing [Vuex-ORM](https://github.com/vuex-orm/vuex-orm), which brings
4+
Object-Relational Mapping access to the Vuex Store. Vuex-ORM-GraphQL enhances Vuex-ORM to let you sync your Vuex state
5+
via the Vuex-ORM models with your server via a [GraphQL API](http://graphql.org/).
6+
7+
The plugin will automatically generate GraphQL queries and mutations based on your model definitions and thus hides
8+
the specifics of Network Communication, GraphQL, Caching, De- and Serialization of your Data and so on from the
9+
developer. Getting a record of a model from the server is as easy as calling `Product.fetch()`. This allows you to write
10+
sophisticated Single-Page Applications fast and efficient without worrying about GraphQL.
611

7-
::: warning
8-
This plugin is in BETA stage, please use with care.
9-
:::
1012

1113
::: warning
1214
You should have basic knowledge of [Vue](https://vuejs.org/), [Vuex](https://vuex.vuejs.org/) and

0 commit comments

Comments
 (0)