Skip to content

Commit 73ca530

Browse files
committed
improving docs
1 parent 8ef700c commit 73ca530

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Enabling proper caching strategies will drastically reduce the latency of your s
5959
For our services, we are talking here about improvements in response times from `X ms` to `~2ms`, as an example.
6060

6161
### Enabling cache for service endpoints
62-
Enabling an response to be cached just requires the
62+
Enabling a response to be cached just requires the
6363
`x-cache-timeout` header to be set:
6464
```js
6565
res.setHeader('x-cache-timeout', '1 hour')
@@ -104,12 +104,20 @@ service.use((req, res, next) => {
104104
return next()
105105
})
106106
```
107-
> In this example we also distinguish cache entries by `user.id`, very common case!
107+
> In this example we also distinguish cache entries by `user.id`, very important for authorization reasons.
108108
109109
### Disable cache for custom endpoints
110110
You can also disable cache checks for certain requests programmatically:
111111
```js
112112
service.use((req, res, next) => {
113113
req.cacheDisabled = true
114114
return next()
115-
})
115+
})
116+
117+
## Want to contribute?
118+
This is your repo ;)
119+
120+
> Note: We aim to be 100% code coverage, please consider it on your pull requests.
121+
122+
## Related projects
123+
- fast-gateway (https://www.npmjs.com/package/fast-gateway)

0 commit comments

Comments
 (0)