Skip to content

Commit 724c953

Browse files
authored
docs(readme): grammar fixes (#61)
Signed-off-by: Frazer Smith <[email protected]>
1 parent 38d94f5 commit 724c953

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# @fastify/fast-json-stringify-compiler
2-
Build and manage the [`fast-json-stringify`](https://www.npmjs.com/package/fast-json-stringify) instances for the fastify framework.
3-
This package is responsible for compiling the application's `response` JSON schemas into optimized functions to speed up the response time.
42

5-
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
63
[![CI](https://github.com/fastify/fast-json-stringify-compiler/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fast-json-stringify-compiler/actions/workflows/ci.yml)
4+
[![NPM version](https://img.shields.io/npm/v/@fastify/fast-json-stringify-compiler.svg?style=flat)](https://www.npmjs.com/package/@fastify/fast-json-stringify-compiler)
5+
[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
76

7+
Build and manage the [`fast-json-stringify`](https://www.npmjs.com/package/fast-json-stringify) instances for the Fastify framework.
8+
This package is responsible for compiling the application's `response` JSON schemas into optimized functions to speed up the response time.
89

910
## Versions
1011

@@ -17,7 +18,7 @@ This package is responsible for compiling the application's `response` JSON sche
1718

1819
### fast-json-stringify Configuration
1920

20-
The `fast-json-stringify` configuration is the default one. You can check it the default settings in the [`fast-json-stringify` option](https://github.com/fastify/fast-json-stringify/#options) documentation.
21+
The `fast-json-stringify` configuration is the default one. You can check the default settings in the [`fast-json-stringify` option](https://github.com/fastify/fast-json-stringify/#options) documentation.
2122

2223
You can also override the default configuration by passing the [`serializerOpts`](https://fastify.dev/docs/latest/Reference/Server/#serializeropts) configuration to the Fastify instance.
2324

@@ -28,7 +29,7 @@ If you need to provide to your server instance a different version, refer to [th
2829

2930
### fast-json-stringify Standalone
3031

31-
`[email protected]` introduces the [standalone feature](https://github.com/fastify/fast-json-stringify#standalone) that let you to pre-compile your schemas and use them in your application for a faster startup.
32+
`[email protected]` introduces the [standalone feature](https://github.com/fastify/fast-json-stringify#standalone) that lets you pre-compile your schemas and use them in your application for a faster startup.
3233

3334
To use this feature, you must be aware of the following:
3435

@@ -43,7 +44,7 @@ To accomplish this, you must use a new compiler: `@fastify/fast-json-stringify-c
4344

4445
You must provide 2 parameters to this compiler:
4546

46-
- `readMode: false`: a boolean to indicate that you want generate the schemas functions string.
47+
- `readMode: false`: a boolean to indicate that you want to generate the schemas functions string.
4748
- `storeFunction`" a sync function that must store the source code of the schemas functions. You may provide an async function too, but you must manage errors.
4849

4950
When `readMode: false`, **the compiler is meant to be used in development ONLY**.
@@ -84,7 +85,7 @@ app.ready().then(() => {
8485
At this stage, you should have a file for every route's schema.
8586
To use them, you must use the `@fastify/fast-json-stringify-compiler/standalone` with the parameters:
8687

87-
- `readMode: true`: a boolean to indicate that you want read and use the schemas functions string.
88+
- `readMode: true`: a boolean to indicate that you want to read and use the schemas functions string.
8889
- `restoreFunction`" a sync function that must return a function to serialize the route's payload.
8990

9091
Important keep away before you continue reading the documentation:
@@ -120,7 +121,7 @@ app.listen({ port: 3000 })
120121

121122
### How it works
122123

123-
This module provide a factory function to produce [Serializer Compilers](https://fastify.dev/docs/latest/Reference/Server/#serializercompiler) functions.
124+
This module provides a factory function to produce [Serializer Compilers](https://fastify.dev/docs/latest/Reference/Server/#serializercompiler) functions.
124125

125126
## License
126127

0 commit comments

Comments
 (0)