Skip to content

Commit 4a78807

Browse files
authored
Update README.md
1 parent cfac178 commit 4a78807

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,14 @@
44
<h1>
55
@bedtime-coders/elysia-openapi
66
</h1>
7-
<a href="https://npmjs.com/package/@bedtime-coders/elysia-openapi">
8-
<img src="https://img.shields.io/npm/v/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="npm version" />
9-
</a>
10-
<a href="https://bundlephobia.com/package/@bedtime-coders/elysia-openapi">
11-
<img src="https://img.shields.io/bundlephobia/minzip/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="bundlephobia" />
12-
</a>
13-
<a href="https://elysiajs.com/">
14-
<img src="https://img.shields.io/badge/%F0%9F%A6%8A-f6f8fa?label=elysia&color=blue" alt="elysia" />
15-
</a>
7+
<a href="https://npmjs.com/package/@bedtime-coders/elysia-openapi"><img src="https://img.shields.io/npm/v/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="npm version" /></a>
8+
<a href="https://bundlephobia.com/package/@bedtime-coders/elysia-openapi"><img src="https://img.shields.io/bundlephobia/minzip/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="bundlephobia" /></a>
9+
<a href="https://elysiajs.com/"><img src="https://img.shields.io/badge/%F0%9F%A6%8A-f6f8fa?label=elysia&color=blue" alt="elysia" /></a>
1610
</div>
1711

1812
Use this plugin to effortlessly expose a beautiful [OpenAPI](https://github.com/OAI/OpenAPI-Specification) reference page from your ElysiaJS application with zero configuration. Just add the plugin to your Elysia app and you're good to go!
1913

20-
👉 **Why use this over `@elysiajs/swagger`?** This is a fork of `@elysiajs/swagger` with updated dependencies and [a few other opinionated changes](#changes-from-elysiajs-swagger). If [@elysiajs/swagger](https://github.com/elysiajs/elysia-swagger) suits your needs (and you don't need the latest version of [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference)), then by all means, use that instead.
14+
👉 **Why use this over `@elysiajs/swagger`?** This is a fork of [@elysiajs/swagger](https://github.com/elysiajs/elysia-swagger) with updated dependencies and [a few other opinionated changes](#changes-from-elysiajsswagger). If `@elysiajs/swagger` suits your needs (and you don't need the latest version of [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference)), then by all means, use that instead.
2115

2216
## Add it to your Elysia app
2317
```bash
@@ -117,4 +111,4 @@ Paths to exclude from the Swagger endpoint
117111
[github-stars-href]: https://github.com/bedtime-coders/elysia-openapi/stargazers
118112

119113
<!-- Public assets -->
120-
[header-src]: ./public/header.png
114+
[header-src]: ./public/header.png

0 commit comments

Comments
 (0)