Skip to content

Commit cf535c5

Browse files
committed
Update README.md
1 parent 0752f24 commit cf535c5

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# vuex-orm-apollo
22

3-
[![Travis CI](https://travis-ci.org/phortx/vuex-orm-apollo.svg?branch=master)](https://travis-ci.org/vuex-orm/vuex-orm-apollo)
3+
[![Travis CI](https://travis-ci.org/vuex-orm/vuex-orm-apollo.svg?branch=master)](https://travis-ci.org/vuex-orm/vuex-orm-apollo)
44
[![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/core.svg)](https://github.com/vuex-orm/vuex-orm/blob/master/LICENSE.md)
5+
[![License](https://img.shields.io/npm/l/@vuex-orm/vuex-orm-apollo.svg)](https://github.com/vuex-orm/vuex-orm-apollo/blob/master/LICENSE.md)
66

7-
This Vuex-ORM plugin let's you sync the data against a GraphQL API via Apollo.
7+
This [Vuex-ORM](https://github.com/vuex-orm/vuex-orm) plugin uses the
8+
[apollo-client](https://www.apollographql.com/client/) to let you sync your Vuex state with
9+
a [GraphQL API](http://graphql.org/)
810

9-
**Warning:** This plugin is still under development, use with care.
11+
**Warning:** This is a early version of the plugin, please don't use in production yet.
1012

1113

1214
## Usage
@@ -85,20 +87,7 @@ This plugin has an opinion how the GraphQL API schema should look like:
8587
- The update mutation expects two arguments: The ID and the new record
8688
- The delete mutation expects the record ID to delete
8789

88-
You can see query examples in the [project wiki](https://github.com/vuex-orm/vuex-orm-apollo/wiki).
89-
90-
91-
## Roadmap
92-
93-
- [x] Setup apollo integration
94-
- [x] Implement fetch action
95-
- [x] Make sure the reactivity works
96-
- [x] destroy, push & persist
97-
- [ ] Playground project (GraphQL API + Vue/Vuex-ORM app)
98-
- [x] Tests
99-
- [x] Docs & document schema expectations
100-
- [ ] Subscriptions
101-
- [ ] Attach multiple GraphQL APIs with different models in the same app
90+
You can see query examples in the [project wiki](https://github.com/vuex-orm/vuex-orm-apollo/wiki/Example-Queries).
10291

10392

10493

0 commit comments

Comments
 (0)