Skip to content

Commit d7b4c81

Browse files
authored
docs(readme): standardize compat table (#488)
* docs(readme): standardize compat table Signed-off-by: Frazer Smith <[email protected]> * Update README.md Signed-off-by: Frazer Smith <[email protected]> --------- Signed-off-by: Frazer Smith <[email protected]>
1 parent 488baa7 commit d7b4c81

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,27 @@
44
[![NPM version](https://img.shields.io/npm/v/@fastify/static.svg?style=flat)](https://www.npmjs.com/package/@fastify/static)
55
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
66

7-
Plugin for serving static files as fast as possible. Supports Fastify version `4.x`.
8-
9-
| Fastify version | branch |
10-
| --------------- | -------------------------------------------------------------------- |
11-
| `^5.x` | This branch
12-
| `^4.x` | [`v7.x`](https://github.com/fastify/fastify-static/tree/v7.x) |
13-
| `^3.x` | [`v5.x`](https://github.com/fastify/fastify-static/tree/v5.x) |
14-
| `^2.x` | [`2.x`](https://github.com/fastify/fastify-static/tree/2.x) |
15-
| `^1.11.x` | [`1.x`](https://github.com/fastify/fastify-static/tree/1.x) |
7+
Plugin for serving static files as fast as possible.
168

179
## Install
10+
```
11+
npm i @fastify/static
12+
```
13+
14+
### Compatibility
15+
16+
| Plugin version | Fastify version |
17+
| ---------------|-----------------|
18+
| `^8.x` | `^5.x` |
19+
| `^7.x` | `^4.x` |
20+
| `^5.x` | `^3.x` |
21+
| `^2.x` | `^2.x` |
22+
| `^1.x` | `^1.x` |
23+
1824

19-
`npm i @fastify/static`
25+
Please note that if a Fastify version is out of support, then so are the corresponding version(s) of this plugin
26+
in the table above.
27+
See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.
2028

2129
## Usage
2230

@@ -492,4 +500,4 @@ fastify.addHook('onSend', function (req, reply, payload, next) {
492500

493501
## License
494502

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

0 commit comments

Comments
 (0)