docs: update README (#910)
parent
25e4c1e936
commit
71312ef64b
11
README.md
11
README.md
|
@ -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`.
|
||||
You can install it with the following command.
|
||||
|
||||
```
|
||||
```plain
|
||||
npm install @hono/hello
|
||||
```
|
||||
|
||||
|
@ -26,10 +26,9 @@ import { hello } from 'npm:@hono/hello'
|
|||
|
||||
## How to contribute
|
||||
|
||||
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 maintains it.
|
||||
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 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 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.
|
||||
Run the following command at the top level to describe any changes.
|
||||
|
||||
```
|
||||
```plain
|
||||
yarn changeset
|
||||
```
|
||||
|
||||
|
|
Loading…
Reference in New Issue