suimeng
/
honojs-middleware
mirror of https://github.com/honojs/middleware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README (#910)

pull/911/head
Yusuke Wada 2024-12-26 15:04:54 +09:00 committed by GitHub
parent 25e4c1e936
commit 71312ef64b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -14,7 +14,7 @@ Hono has three types of middleware.
Third-party middleware is maintained in this `github.com/honojs/middleware` repository and published to npm in the `@hono` namespace. For example, a third-party middleware called hello is hosted at `github.com/honojs/middleware/packages/hello` and distributed under the name `@hono/hello`. Third-party middleware is maintained in this `github.com/honojs/middleware` repository and published to npm in the `@hono` namespace. For example, a third-party middleware called hello is hosted at `github.com/honojs/middleware/packages/hello` and distributed under the name `@hono/hello`.
You can install it with the following command. You can install it with the following command.
``` ```plain
npm install @hono/hello npm install @hono/hello
``` ```
@ -26,10 +26,9 @@ import { hello } from 'npm:@hono/hello'
## How to contribute ## How to contribute
Anyone can propose third-party Middleware. Anyone can propose third-party Middleware. The Hono maintainers and other contributors will discuss whether we accept the middleware or not. If it's OK, it will be maintained in this repository. The proposer will be the maintainer for the middleware and maintain it.
The Hono maintainers and other contributors will discuss whether we accept the middleware or not.
If it's OK, it will be maintained in this repository. The middleware maintainer should respond to issues and review PRs related to the middleware as much as possible. The Hono maintainers sometimes will mention the middleware maintainer using an `@` like `@yusukebe Can you take a look?`.
The proposer maintains it.
The specific flow is as follows The specific flow is as follows
@ -40,7 +39,7 @@ The specific flow is as follows
We use [changesets](https://github.com/changesets/changesets) to manage releases and CHANGELOG. We use [changesets](https://github.com/changesets/changesets) to manage releases and CHANGELOG.
Run the following command at the top level to describe any changes. Run the following command at the top level to describe any changes.
``` ```plain
yarn changeset yarn changeset
``` ```