Skip to content

docs(readme): add compatibility table #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2024
Merged

docs(readme): add compatibility table #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions Readme.md → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
that provides server-side caching and mechanisms for manipulating HTTP cache headers according to
[RFC 2616 §14.9](https://tools.ietf.org/html/rfc2616#section-14.9).

Supports Fastify versions ^3.0.0. Version v5.x supports Fastify ^3.0.0 in
the [`v5.x` branch](https://github.com/fastify/fastify-caching/tree/v5.x).

This plugin fully supports Fastify's encapsulation. Therefore, routes that
should have differing cache settings should be registered within different
contexts.
Expand All @@ -24,6 +21,25 @@ recommended that a full featured cache object be supplied, e.g.

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

## Install
```
npm i @fastify/caching
```

### Compatibility
| Plugin version | Fastify version |
| ---------------|-----------------|
| `^9.x` | `^5.x` |
| `^8.x` | `^4.x` |
| `^6.x` | `^3.x` |
| `^4.x` | `^2.x` |
| `^1.x` | `^1.x` |


Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
in the table above.
See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.

## Example

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

## License

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