Skip to content

Commit

Permalink
docs: solve #120 swagger plugin version (#123)
Browse files Browse the repository at this point in the history
Signed-off-by: RodrigoDornelles <rodrigo@dornelles.me>
  • Loading branch information
RodrigoDornelles authored Jan 31, 2024
1 parent 6a98145 commit 5119f09
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

A Fastify plugin for serving [Swagger UI](https://swagger.io/tools/swagger-ui/).

Supports Fastify versions `4.x`.

![Demo](https://user-images.githubusercontent.com/52195/228162405-c85ad0d1-900d-442a-b712-7108d98d621f.png)

<a name="install"></a>
Expand All @@ -16,6 +14,13 @@ Supports Fastify versions `4.x`.
npm i @fastify/swagger-ui
```

### Compatibility

| Plugin version | Fastify version | Swagger Plugin Version |
| -------------- | --------------- | ---------------------- |
| `^2.0.0` | `^4.0.0` | `^8.0.0` |
| `^1.0.0` | `^4.0.0` | `^8.0.0` |

<a name="usage"></a>
## Usage
Add it with `@fastify/swagger` to your project with `register`, pass it some options, call the `swagger` API, and you are done!
Expand Down

0 comments on commit 5119f09

Please sign in to comment.