Skip to content

Commit cfac178

Browse files
committed
📖 docs: update README with new section on changes from @elysiajs/swagger and improved descriptions for clarity
1 parent 391cf2b commit cfac178

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
<div align="center">
22
<img src="./public/header.png" alt="header" width="100%" />
3+
4+
<h1>
5+
@bedtime-coders/elysia-openapi
6+
</h1>
37
<a href="https://npmjs.com/package/@bedtime-coders/elysia-openapi">
48
<img src="https://img.shields.io/npm/v/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="npm version" />
59
</a>
@@ -11,13 +15,9 @@
1115
</a>
1216
</div>
1317

14-
<h1 align="center">
15-
@bedtime-coders/elysia-openapi
16-
</h1>
17-
18-
Use this plugin to 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!
18+
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!
1919

20-
👉 **Why use this over `@elysiajs/swagger`?** This is a fork of `@elysiajs/swagger` with updated dependencies and a few opinionated changes to the defaults. 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.
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.
2121

2222
## Add it to your Elysia app
2323
```bash
@@ -63,6 +63,14 @@ const app = new Elysia()
6363

6464
Visit `http://localhost:8080/docs` to see the generated OpenAPI reference page ✨
6565

66+
## Changes from `@elysiajs/swagger`
67+
68+
- Update dependencies to the latest versions (at the time of writing), including [Scalar API Reference](https://github.com/scalar/scalar)
69+
- Fix code to support the latest version of these dependencies
70+
- Rename plugin from `swagger` to `openapi`
71+
- Change the default API Reference path to `/docs`, serving either Scalar API Reference (default) or Swagger UI
72+
- Change the default `openapi.json` serving path to `/docs/json`
73+
6674
## Give us a ⭐️
6775

6876
Hey! If you like this plugin, please give us a ⭐️ on GitHub so more people can find it. Thank you!

0 commit comments

Comments
 (0)