Skip to content

Commit f1da97e

Browse files
committed
Update README
1 parent 0348e93 commit f1da97e

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,45 @@
1-
# Vuex ORM Plugin: GraphQl
1+
<p align="center">
2+
<img width="192" src="https://github.com/vuex-orm/vuex-orm/blob/master/logo-vuex-orm.png" alt="Vuex ORM">
3+
</p>
24

3-
[![Travis CI](https://travis-ci.org/vuex-orm/plugin-graphql.svg?branch=master)](https://travis-ci.org/vuex-orm/plugin-graphql)
4-
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
5-
[![License](https://img.shields.io/npm/l/@vuex-orm/plugin-graphql.svg)](https://github.com/vuex-orm/plugin-graphql/blob/master/LICENSE.md)
5+
<h1 align="center">Vuex ORM Plugin: GraphQl</h1>
66

7-
**Documentation:** https://vuex-orm.github.io/plugin-graphql/
7+
<p align="center">
8+
<a href="https://travis-ci.org/vuex-orm/plugin-graphql">
9+
<img src="https://travis-ci.org/vuex-orm/plugin-graphql.svg?branch=master" alt="Travis CI">
10+
</a>
11+
<a href="https://standardjs.com">
12+
<img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide">
13+
</a>
14+
<a href="https://github.com/vuex-orm/plugin-graphql/blob/master/LICENSE.md">
15+
<img src="https://img.shields.io/npm/l/@vuex-orm/core.svg" alt="License">
16+
</a>
17+
</p>
818

19+
Vuex-ORM-GraphQL is a plugin for the amazing [Vuex-ORM](https://github.com/vuex-orm/vuex-orm), which brings
20+
Object-Relational Mapping access to the Vuex Store. Vuex-ORM-GraphQL enhances Vuex-ORM to let you sync your Vuex state
21+
via the Vuex-ORM models with your server via a [GraphQL API](http://graphql.org/).
922

10-
**Powered by [i22 Digitalagentur GmbH](https://www.i22.de/)**.
23+
The plugin will automatically generate GraphQL queries and mutations based on your model definitions and by
24+
reading your and GraphQL schema from your server. Thus it hides the specifics of Network Communication, GraphQL,
25+
Caching, De- and Serialization of your Data and so on from the developer. Getting a record of a model from the server
26+
is as easy as calling `Product.fetch()`. This allows you to write sophisticated Single-Page Applications fast and
27+
efficient without worrying about GraphQL.
28+
29+
**This project is powered by [i22 Digitalagentur GmbH](https://www.i22.de/)**.
30+
31+
32+
## Documentation
33+
34+
You can find the complete documentation at https://vuex-orm.github.io/plugin-graphql/.
35+
36+
37+
## Questions & Discussions
38+
39+
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTI0YjE5YmNmMDIxNWZlNmJhM2EyMDg1MDRkODA4YmQwMDU5OWRkZmNhN2RmOTZkZGZkODQxZTRkYjhmYmJiNTY) for any questions and discussions.
40+
41+
While there is the Slack Channel, do not hesitate to open an issue for any question you might have.
42+
We're always more than happy to hear any feedback, and we don't care what kind of form they are.
1143

1244

1345
## Contribution

0 commit comments

Comments
 (0)