Skip to content

Commit bb7bcc0

Browse files
authored
docs: fix headings style in README.md
1 parent 2ef2379 commit bb7bcc0

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@
1111

1212
This is a plugin for [graphql-compose](https://github.com/graphql-compose/graphql-compose), which derives GraphQLType from your [mongoose model](https://github.com/Automattic/mongoose). Also derives bunch of internal GraphQL Types. Provide all CRUD resolvers, including `graphql connection`, also provided basic search via operators ($lt, $gt and so on).
1313

14-
Installation
15-
============
14+
## Installation
1615
```
1716
npm install graphql graphql-compose mongoose graphql-compose-mongoose --save
1817
```
@@ -36,17 +35,17 @@ import { composeWithMongoose } from 'graphql-compose-mongoose/node8';
3635
import { composeWithMongoose } from 'graphql-compose-mongoose/es';
3736
```
3837

39-
Example
40-
=======
38+
## Example
39+
4140
Live demo: [https://graphql-compose.herokuapp.com/](https://graphql-compose.herokuapp.com/)
4241

4342
Source code: https://github.com/graphql-compose/graphql-compose-mongoose-example
4443

4544
Small explanation for varaibles naming:
4645
- `UserSchema` - this is a mongoose schema
4746
- `User` - this is a mongoose model
48-
- `UserTC` - this is a TypeComposer instance for User. TypeComposer has GraphQLObjectType inside, avaliable via method UserTC.getType().
49-
- Here and in all other places of code suffix `...TC` means that this is TypeComposer instance, `...ITC` - InputTypeComposer, `...ETC` - EnumTypeComposer.
47+
- `UserTC` - this is a `TypeComposer` instance for User. `TypeComposer` has `GraphQLObjectType` inside, avaliable via method `UserTC.getType()`.
48+
- Here and in all other places of code variables suffix `...TC` means that this is `TypeComposer` instance, `...ITC` - `InputTypeComposer`, `...ETC` - `EnumTypeComposer`.
5049

5150
```js
5251
import mongoose from 'mongoose';
@@ -123,8 +122,8 @@ You think that is to much code?
123122
I don't think so, because by default internally was created about 55 graphql types (for input, sorting, filtering). So you will need much much more lines of code to implement all these CRUD operations by hands.
124123

125124

126-
FAQ
127-
===
125+
## FAQ
126+
128127
### Can I get generated vanilla GraphQL types?
129128
```js
130129
const UserTC = composeWithMongoose(User);
@@ -253,8 +252,8 @@ fragment fullImageData on EmbeddedImage {
253252
}
254253
```
255254

256-
Customization options
257-
=====================
255+
## Customization options
256+
258257
When we convert model `const UserTC = composeWithMongoose(User, customizationOptions);` you may tune every piece of future derived types and resolvers.
259258

260259
### Here is flow typed definition of this options:
@@ -381,8 +380,8 @@ export type limitHelperArgsOpts = {
381380
};
382381
```
383382

384-
Used plugins
385-
============
383+
## Used plugins
384+
386385
### [graphql-compose-connection](https://github.com/graphql-compose/graphql-compose-connection)
387386
This plugin adds `connection` resolver. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields).
388387

@@ -395,6 +394,6 @@ This plugin completely follows to [Relay Cursor Connections Specification](https
395394
### [graphql-compose-pagination](https://github.com/graphql-compose/graphql-compose-pagination)
396395
This plugin adds `pagination` resolver.
397396

398-
License
399-
=======
397+
## License
400398
[MIT](https://github.com/graphql-compose/graphql-compose-mongoose/blob/master/LICENSE.md)
399+

0 commit comments

Comments
 (0)