Skip to content

Commit 8bcd94b

Browse files
authored
docs(readme): add compatibility table (#161)
Signed-off-by: Frazer Smith <[email protected]>
1 parent 409cdb8 commit 8bcd94b

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

Readme.md renamed to README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
that provides server-side caching and mechanisms for manipulating HTTP cache headers according to
99
[RFC 2616 §14.9](https://tools.ietf.org/html/rfc2616#section-14.9).
1010

11-
Supports Fastify versions ^3.0.0. Version v5.x supports Fastify ^3.0.0 in
12-
the [`v5.x` branch](https://github.com/fastify/fastify-caching/tree/v5.x).
13-
1411
This plugin fully supports Fastify's encapsulation. Therefore, routes that
1512
should have differing cache settings should be registered within different
1613
contexts.
@@ -24,6 +21,25 @@ recommended that a full featured cache object be supplied, e.g.
2421

2522
[acache-redis]: https://www.npmjs.com/package/abstract-cache-redis
2623

24+
## Install
25+
```
26+
npm i @fastify/caching
27+
```
28+
29+
### Compatibility
30+
| Plugin version | Fastify version |
31+
| ---------------|-----------------|
32+
| `^9.x` | `^5.x` |
33+
| `^8.x` | `^4.x` |
34+
| `^6.x` | `^3.x` |
35+
| `^4.x` | `^2.x` |
36+
| `^1.x` | `^1.x` |
37+
38+
39+
Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
40+
in the table above.
41+
See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.
42+
2743
## Example
2844

2945
This example shows using the plugin to disable client side caching of all
@@ -149,4 +165,4 @@ object, or a string that is a valid date string according to
149165

150166
## License
151167

152-
[MIT License](https://jsumners.mit-license.org/)
168+
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)