From a6878b60475ea3ef9e63919c6d974c70f056f8af Mon Sep 17 00:00:00 2001 From: Yusuke Wada Date: Sat, 4 Feb 2023 20:31:47 +0900 Subject: [PATCH] docs(readme): update --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fb6f2144..ac6edcfe 100644 --- a/README.md +++ b/README.md @@ -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. 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 ``` -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 import { hello } from 'npm:@hono/hello' @@ -27,9 +27,9 @@ import { hello } from 'npm:@hono/hello' ## How to contribute 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. -Basically, the proposer maintains it. +The proposer maintains it. The specific flow is as follows @@ -44,15 +44,10 @@ Run the following command at the top level to describe any changes. 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. -## 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 The Author of this repository is Yusuke Wada <>. However, the code under the `packges/*` is in each Middleware author. -Basically, distribute under the MIT license. +Basically, distributed under the MIT license.