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

docs(readme): update

pull/36/head
Yusuke Wada 2023-02-04 20:31:47 +09:00
parent 3b63ce2b93
commit a6878b6047
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -12,13 +12,13 @@ Hono has three types of middleware.
3. Third-party middleware - Created outside of the core package. It can depend on the external libraries. 3. Third-party middleware - Created outside of the core package. It can depend on the external libraries.
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 with the following command. You can install it with the following command.
``` ```
npm install @hono/hello npm install @hono/hello
``` ```
For Deno, the modules, we do not publish them on `deno.land/x`, but distribute them via CDNs such as Skypack and esm.sh. We will also use the `npm:` that will be introduced in the Deno itself in the future. For Deno, we do not publish them on `deno.land/x`, but distribute them via CDNs such as Skypack and esm.sh. We will also use the `npm:` that will be introduced in the Deno itself in the future.
```ts ```ts
import { hello } from 'npm:@hono/hello' import { hello } from 'npm:@hono/hello'
@ -27,9 +27,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 to whether we accept the middleware or not. 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. If it's OK, it will be maintained in this repository.
Basically, the proposer maintains it. The proposer maintains it.
The specific flow is as follows The specific flow is as follows
@ -44,15 +44,10 @@ Run the following command at the top level to describe any changes.
yarn changeset yarn changeset
``` ```
When merged into main, a pull request for release is created. When merged into the main, a pull request for release is created.
The Hono maintainers will merge it to release the package at the appropriate time. The Hono maintainers will merge it to release the package at the appropriate time.
## Migration from the repository
If possible, please migrate middleware previously managed in an independent repository to this one.
Create the pull request with the content in the middleware repository. Perhaps `git-subtree` might be useful.
## Author & License ## Author & License
The Author of this repository is Yusuke Wada <<https://github.com/yusukebe>>. However, the code under the `packges/*` is in each Middleware author. The Author of this repository is Yusuke Wada <<https://github.com/yusukebe>>. However, the code under the `packges/*` is in each Middleware author.
Basically, distribute under the MIT license. Basically, distributed under the MIT license.