Skip to content

Commit 3da6b22

Browse files
authored
docs(readme): spelling and grammar fixes (#400)
Signed-off-by: Frazer Smith <frazer.dev@icloud.com>
1 parent 954a642 commit 3da6b22

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
@@ -11,7 +11,7 @@ received with a given prefix (or none) to an upstream. All Fastify hooks are sti
1111
`@fastify/http-proxy` is built on top of
1212
[`@fastify/reply-from`](https://npm.im/@fastify/reply-from), which enables single route proxying.
1313

14-
This plugin can be used in a variety of circumstances, for example if you have to proxy an internal domain to an external domain (useful to avoid CORS problems) or to implement your own API gateway for a microservices architecture.
14+
This plugin can be used in a variety of circumstances, for example, if you have to proxy an internal domain to an external domain (useful to avoid CORS problems) or to implement your own API gateway for a microservices architecture.
1515

1616
## Requirements
1717

@@ -39,7 +39,7 @@ server.register(require('@fastify/http-proxy'), {
3939
server.listen({ port: 3000 });
4040
```
4141

42-
This will proxy any request starting with `/api` to `http://my-api.example.com`. For instance `http://localhost:3000/api/users` will be proxied to `http://my-api.example.com/users`.
42+
This will proxy any request starting with `/api` to `http://my-api.example.com`. For instance, `http://localhost:3000/api/users` will be proxied to `http://my-api.example.com/users`.
4343

4444
If you want to have different proxies on different prefixes you can register multiple instances of the plugin as shown in the following snippet:
4545

@@ -81,9 +81,9 @@ server.register(proxy, {
8181
server.listen({ port: 3000 });
8282
```
8383

84-
Notice that in this case it is important to use the `prefix` option to tell the proxy how to properly route the requests across different upstreams.
84+
Notice that in this case, it is important to use the `prefix` option to tell the proxy how to properly route the requests across different upstreams.
8585

86-
Also notice paths in `upstream` are ignored, so you need to use `rewritePrefix` to specify the target base path.
86+
Also, notice paths in `upstream` are ignored, so you need to use `rewritePrefix` to specify the target base path.
8787

8888
For other examples, see [`example.js`](examples/example.js).
8989

@@ -229,7 +229,7 @@ The default implementation forwards the `cookie` header.
229229

230230
## Benchmarks
231231

232-
The following benchmarks where generated on a dedicated server with an Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz and 64GB of RAM:
232+
The following benchmarks were generated on a dedicated server with an Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz and 64GB of RAM:
233233

234234
| **Framework** | req/sec |
235235
| :-------------------- | :------ |
@@ -247,4 +247,4 @@ URL`.
247247

248248
## License
249249

250-
MIT
250+
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)