0
0
mirror of https://github.com/honojs/hono.git synced 2024-12-01 10:51:01 +00:00
hono/README.md

106 lines
4.1 KiB
Markdown
Raw Normal View History

<div align="center">
<a href="https://hono.dev">
<img src="https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width="500" height="auto" alt="Hono"/>
</a>
</div>
<hr />
2021-12-14 20:17:56 +00:00
<p align="center">
<a href="https://hono.dev"><b>Documentation :point_right: hono.dev</b></a><br />
<i>v3 has been released!</i> <a href="docs/MIGRATION.md">Migration guide</b>
</p>
<hr />
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/honojs/hono/ci.yml?branch=main)](https://github.com/honojs/hono/actions)
[![GitHub](https://img.shields.io/github/license/honojs/hono)](https://github.com/honojs/hono/blob/main/LICENSE)
2022-02-21 15:01:31 +00:00
[![npm](https://img.shields.io/npm/v/hono)](https://www.npmjs.com/package/hono)
2022-02-23 02:20:29 +00:00
[![npm](https://img.shields.io/npm/dm/hono)](https://www.npmjs.com/package/hono)
[![Bundle Size](https://img.shields.io/bundlephobia/min/hono)](https://bundlephobia.com/result?p=hono)
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/hono)](https://bundlephobia.com/result?p=hono)
2022-02-21 15:01:31 +00:00
[![npm type definitions](https://img.shields.io/npm/types/hono)](https://www.npmjs.com/package/hono)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/honojs/hono)](https://github.com/honojs/hono/pulse)
[![GitHub last commit](https://img.shields.io/github/last-commit/honojs/hono)](https://github.com/honojs/hono/commits/main)
2022-07-02 12:48:32 +00:00
[![Deno badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fhono%2Fmod.ts)](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
[![Discord badge](https://img.shields.io/discord/1011308539819597844?label=Discord&logo=Discord)](https://discord.gg/KMh2eNSdxV)
2022-02-21 15:01:31 +00:00
2023-04-08 09:34:03 +00:00
Hono - _**\[炎\] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for the Edges.
It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Lagon, AWS Lambda, Lambda@Edge, and Node.js.
2023-05-13 23:33:34 +00:00
Fast, but not only fast.
2021-12-17 06:53:31 +00:00
2022-05-13 03:30:06 +00:00
```ts
import { Hono } from 'hono'
const app = new Hono()
2021-12-17 06:53:31 +00:00
app.get('/', (c) => c.text('Hono!'))
2021-12-17 06:53:31 +00:00
export default app
2021-12-17 06:53:31 +00:00
```
2023-02-22 20:47:56 +00:00
## Quick Start
```
npm create hono@latest my-app
```
2022-01-08 00:48:22 +00:00
## Features
2021-12-17 06:53:31 +00:00
- **Ultrafast** 🚀 - The router `RegExpRouter` is really fast. Not using linear loops. Fast.
- **Lightweight** 🪶 - The `hono/tiny` preset is under 14kB. Hono has zero dependencies and uses only the Web Standard API.
- **Multi-runtime** 🌍 - Works on Cloudflare Workers, Fastly Compute, Deno, Bun, Lagon, AWS Lambda, Lambda@Edge, or Node.js. The same code runs on all platforms.
- **Batteries Included** 🔋 - Hono has built-in middleware, custom middleware, and third-party middleware. Batteries included.
- **Delightful DX** 😃 - Super clean APIs. First-class TypeScript support. Now, we've got "Types".
2021-12-14 20:17:56 +00:00
2022-07-02 09:29:09 +00:00
## Benchmarks
**Hono is the fastest**, compared to other routers for Cloudflare Workers.
```
Hono x 510,171 ops/sec ±4.61% (82 runs sampled)
itty-router x 285,810 ops/sec ±4.13% (85 runs sampled)
sunder x 345,272 ops/sec ±4.46% (87 runs sampled)
worktop x 203,468 ops/sec ±3.03% (91 runs sampled)
2022-09-20 14:06:05 +00:00
Fastest is Hono
✨ Done in 28.68s.
2021-12-27 16:34:09 +00:00
```
## Documentation
2022-07-08 00:22:10 +00:00
The documentation is available on [hono.dev](https://hono.dev).
2021-12-14 20:31:37 +00:00
## Migration
The migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md).
2021-12-14 20:31:37 +00:00
## Communication
[Twitter](https://twitter.com/honojs) and [Discord channel](https://discord.gg/KMh2eNSdxV) are available.
## Contributing
2022-04-25 22:58:08 +00:00
Contributions Welcome! You can contribute in the following ways.
- Create an Issue - Propose a new feature. Report a bug.
- Pull Request - Fix a bug and typo. Refactor the code.
- Create third-party middleware - Instruct below.
- Share - Share your thoughts on the Blog, Twitter, and others.
- Make your application - Please try to use Hono.
For more details, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
2022-02-15 08:19:53 +00:00
## Contributors
2023-05-13 23:33:34 +00:00
Thanks to [all contributors](https://github.com/honojs/hono/graphs/contributors)!
2022-02-15 08:19:53 +00:00
2023-04-08 09:34:03 +00:00
## Authors
2021-12-14 19:26:22 +00:00
Yusuke Wada <https://github.com/yusukebe>
2023-05-13 23:33:34 +00:00
_RegExpRouter_, _SmartRouter_, _LinearRouter_, and _PatternRouter_ are created by Taku Amano <https://github.com/usualoma>
2021-12-14 19:26:22 +00:00
## License
2022-01-07 08:34:12 +00:00
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.