Skip to content

Commit 6024f23

Browse files
committed
Update readme
1 parent b390687 commit 6024f23

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
graphql-compose-connection
22
======================
3-
This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose) family, which adds to the GraphQL types `connection` resolvers.
3+
This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose) family, which adds to the TypeComposer `connection` resolver.
44

55
[Live example](https://graphql-compose-mongoose.herokuapp.com)
66

77
This package completely follows to Relay Cursor Connections Specification (https://facebook.github.io/relay/graphql/connections.htm).
88

9-
Besides standard connection arguments `first`, `last`, `before` and `after`, also added great arguments:
9+
Besides standard connection arguments `first`, `last`, `before` and `after`, also added significant arguments:
1010
* `filter` arg - for filtering records
1111
* `sort` arg - for sorting records. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields).
1212

@@ -18,7 +18,7 @@ Installation
1818
npm install graphql graphql-compose graphql-compose-connection --save
1919
```
2020

21-
Modules `graphql` and `graphql-compose` are in `peerDependencies`, so should be installed explicitly in your app. They have global objects and should not have ability to be installed as submodule.
21+
Modules `graphql` and `graphql-compose` are in `peerDependencies`, so should be installed explicitly in your app. They should not installed as submodules, cause internally checks the classes instances.
2222

2323

2424
Example
@@ -76,7 +76,7 @@ Types should have following resolvers:
7676

7777
Used in plugins
7878
===============
79-
[graphql-compose-mongoose](https://github.com/nodkz/graphql-compose-mongoose)
79+
[graphql-compose-mongoose](https://github.com/nodkz/graphql-compose-mongoose) - converts mongoose models to graphql types
8080

8181

8282
License

0 commit comments

Comments
 (0)