Skip to content

Commit 674e157

Browse files
authored
Update README.md
1 parent 73a32ce commit 674e157

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ graphql-compose-relay
22
======================
33
This is a plugin for `graphql-compose`, which wraps GraphQL types with Relay specific things, like `Node` type and interface, `globalId`, `clientMutationId`.
44

5+
[CHANGELOG](https://github.com/nodkz/graphql-compose-relay/blob/master/CHANGELOG.md)
56

67
Example
78
=======
@@ -13,6 +14,7 @@ composeWithRelay(userTypeComposer); // wrap Type with middlewares, that add rela
1314
composeWithRelay(someOtherTypeComposer);
1415
```
1516
That's all!
17+
1618
No annoying `clientMutationId` manipulations (declaration, passthru, stripping from input).
1719
No manual adding/wrapping `id` field. This field returns globally unique ID among all types in format `base64(TypeName + ':' + recordId)`.
1820
All relay magic done internally by middleware for you.
@@ -22,6 +24,7 @@ Requirements
2224
Method `composeWithRelay` accept `TypeComposer` as input argument. So `TypeComposer` should meet following requirements:
2325
- has defined `recordIdFn` (function that from object gives you id)
2426
- should have `findById` resolver
27+
2528
If something is missing `composeWithRelay` throws error.
2629

2730
`TypeComposer` is [graphql-compose](https://github.com/nodkz/graphql-compose) utility, that wraps GraphQL type and provide bunch of useful methods for type manipulation.
@@ -31,8 +34,6 @@ Compatible plugins
3134
- [graphql-compose-mongoose](https://github.com/nodkz/graphql-compose-mongoose)
3235

3336

34-
[CHANGELOG](https://github.com/nodkz/graphql-compose-relay/blob/master/CHANGELOG.md)
35-
3637
License
3738
=======
3839
[MIT](https://github.com/nodkz/graphql-compose-relay/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)