From a3004d40467e2e1b2a660ef39b0718bf1e8ce7ca Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Mon, 23 Dec 2024 10:58:22 +0000 Subject: [PATCH] docs(readme): add compat table Signed-off-by: Frazer Smith --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 39eed7c..4e51d2a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,21 @@ ``` npm i @fastify/basic-auth ``` + +### Compatibility +| Plugin version | Fastify version | +| ---------------|-----------------| +| `^6.x` | `^5.x` | +| `^4.x` | `^4.x` | +| `^1.x` | `^3.x` | +| `^0.x` | `^2.x` | +| `^0.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. + ## Usage This plugin decorates the fastify instance with a `basicAuth` function, which you can use inside any hook before your route handler, or with [`@fastify/auth`](https://github.com/fastify/fastify-auth).