Skip to content

Commit 900c2bf

Browse files
authored
docs(readme): minor grammar changes (#90)
1 parent 880d5e1 commit 900c2bf

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ fastify.register(oauthPlugin, {
9191
### Schema configuration
9292

9393
You can specify your own schema for the `startRedirectPath` end-point. It allows you to create a well-documented document when using `fastify-swagger` together.
94-
Note: `schema` option will override the `tags` option without merge them.
94+
Note: `schema` option will override the `tags` option without merging them.
9595

9696
```js
9797
fastify.register(oauthPlugin, {
@@ -118,8 +118,8 @@ fastify.register(oauthPlugin, {
118118

119119
## Set custom state
120120

121-
The `generateStateFunction` accepts a function to generate the `state` parameter for the OAUTH flow. This function receives the Fastify's `request` object as parameter.
122-
When you set it, it is required to provide the function `checkStateFunction` also in order to validate the states generated.
121+
The `generateStateFunction` accepts a function to generate the `state` parameter for the OAUTH flow. This function receives the Fastify instance's `request` object as parameter.
122+
When you set it, it is required to provide the function `checkStateFunction` in order to validate the states generated.
123123

124124
```js
125125
const validStates = new Set()
@@ -154,9 +154,9 @@ When you set it, it is required to provide the function `checkStateFunction` als
154154
})
155155
```
156156

157-
## Example
157+
## Examples
158158

159-
See the [`example/`](./examples/) folder for more example.
159+
See the [`example/`](./examples/) folder for more examples.
160160

161161
## Reference
162162

@@ -228,4 +228,4 @@ declare module 'fastify' {
228228

229229
Licensed under [MIT](./LICENSE).
230230

231-
*NB:* See [`simple-oauth2`](https://github.com/lelylan/simple-oauth2) license too
231+
*NB* See [`simple-oauth2`](https://github.com/lelylan/simple-oauth2) license too

0 commit comments

Comments
 (0)